Barodoc Overview

Barodoc Overview

Barodoc is a documentation framework built on Astro with MDX support.

Architecture

barodoc/
├── packages/
│   ├── barodoc/          # CLI tool (barodoc serve/build/create)
│   ├── core/             # @barodoc/core - Astro integration & config
│   ├── theme-docs/       # @barodoc/theme-docs - Documentation theme
│   ├── create-barodoc/   # Project scaffolding (pnpm create barodoc)
│   ├── plugin-sitemap/   # @barodoc/plugin-sitemap
│   ├── plugin-search/    # @barodoc/plugin-search
│   └── plugin-analytics/ # @barodoc/plugin-analytics
└── docs/                 # Self-documentation site

Two Usage Modes

Quick Mode (Zero Config)

For simple documentation with just markdown files:

# Create project
barodoc create my-docs
cd my-docs

# Start dev server
barodoc serve

# Build for production
barodoc build

Project structure:

my-docs/
├── barodoc.config.json   # Configuration
├── docs/
│   └── en/
│       ├── introduction.md
│       └── quickstart.md
└── public/
    └── logo.svg

Full Custom Mode

For advanced customization with full Astro project:

# Requires astro.config.mjs
npx astro dev

Project structure:

my-docs/
├── astro.config.mjs      # Astro configuration (required)
├── barodoc.config.json   # Barodoc configuration
├── src/
│   └── content/
│       └── docs/
│           ├── en/
│           └── ko/
└── public/

Key Files

Package Exports

@barodoc/core

import barodoc from "@barodoc/core";
import { loadConfig } from "@barodoc/core/config";
import { getLocaleFromPath } from "@barodoc/core/i18n";
import { definePlugin } from "@barodoc/core/plugins";

@barodoc/theme-docs

import docsTheme from "@barodoc/theme-docs";
import { ThemeToggle, Search, Tabs, Tab } from "@barodoc/theme-docs";

Development Commands

# Run CLI without building (tsx)
pnpm barodoc serve docs

# Build all packages
pnpm build:packages

# Run docs site
pnpm dev

Virtual Modules

Barodoc exposes config via virtual modules:

// Access in Astro components
import config from "virtual:barodoc/config";
import { i18n, defaultLocale, locales } from "virtual:barodoc/i18n";

Converted and distributed by TomeVault — claim your Tome and manage your conversions.