BarodocBarodoc
GitHub

Getting Started

Quick Start

Get started with Barodoc in under 5 minutes

Create a new documentation site with the CLI (zero-config). No package.json or node_modules in your project.

Prerequisites

  • Node.js 20 or higher
  • pnpm (recommended)

Create a New Project

pnpm create barodoc my-docs
cd my-docs

This creates a project with Markdown files and config only—no Astro config or dependencies in the project directory.

Project Structure (CLI / zero-config)

After creation, the project looks like:

my-docs/
├── docs/
│   └── en/
│       ├── introduction.md
│       └── quickstart.md
├── public/
│   └── logo.svg
├── barodoc.config.json
└── .gitignore
  • docs/ – Content per locale (en/, ko/, etc.). File path = URL slug (e.g. en/introduction.md → /docs/introduction).
  • public/ – Static assets (logo, favicon, images).
  • barodoc.config.json – Site name, navigation, theme, i18n.

No src/, no package.json, no astro.config.mjs in this mode.

Development

npx barodoc serve

Opens the site (e.g. http://localhost:4321). The CLI creates a temporary Astro project under .barodoc/ and runs the dev server. You edit only docs/ and barodoc.config.json.

Build

npx barodoc build

Output goes to dist/ (or the path set in config). Deploy this folder to any static host (GitHub Pages, Vercel, Netlify, Cloudflare Pages).

Preview production build

npx barodoc preview

Serves the dist/ output locally so you can check the production build.

Adding more pages

  1. Add a file under docs/en/ (e.g. docs/en/guides/installation.md).
  2. Add the slug to barodoc.config.json under navigation:
{
  "navigation": [
    { "group": "Getting Started", "pages": ["introduction", "quickstart"] },
    { "group": "Guides", "pages": ["guides/installation"] }
  ]
}

Slug = path without locale and without extension: guides/installation.md → guides/installation.

Full custom (Astro) mode

If you need a full Astro project (e.g. custom pages, integrations), use Installation → Manual. That setup uses src/content/docs/, astro.config.mjs, and pnpm dev / pnpm build. This repo’s docs/ site is an example of that mode.

Next steps