Guides
Migration Guide
Migrate to Barodoc from other documentation frameworks.
Migration Guide
Moving to Barodoc from another documentation framework? This guide walks you through the key differences and steps for a smooth migration.
From Docusaurus
Create a Barodoc project
barodoc create my-docsMove your content
Copy your Markdown/MDX files from docs/ into docs/en/ (or your locale folder).
cp -r old-project/docs/* my-docs/docs/en/Update frontmatter
Docusaurus uses sidebar_position and sidebar_label. In Barodoc, navigation order is controlled by barodoc.config.json:
---
- sidebar_position: 1
- sidebar_label: "Getting Started"
+ title: Getting Started
---You can remove Docusaurus-specific frontmatter fields. Barodoc only requires title (or a # Heading).
Configure navigation
Replace Docusaurus sidebars.js with barodoc.config.json navigation:
{
"navigation": [
{
"group": "Getting Started",
"pages": ["introduction", "quickstart"]
}
]
}Update MDX components
Replace Docusaurus components with Barodoc equivalents:
| Docusaurus | Barodoc |
|---|---|
:::note / :::tip / :::warning | <Callout type="note"> / <Callout type="tip"> / <Callout type="warning"> |
<Tabs> / <TabItem> | <Tabs> / <Tab> |
<details> | <Accordion> |
@theme/CodeBlock | Fenced code blocks (built-in) |
From GitBook
Export your content
Export your GitBook space as Markdown files. GitBook provides this in Space Settings → Export.
Create a Barodoc project
barodoc create my-docsReorganize files
GitBook uses SUMMARY.md for navigation. In Barodoc, move your content into docs/en/ and define navigation in barodoc.config.json:
{
"navigation": [
{
"group": "Overview",
"pages": ["introduction", "quickstart"]
},
{
"group": "Guides",
"pages": ["guides/setup", "guides/deployment"]
}
]
}Delete SUMMARY.md — it’s no longer needed.
Update image paths
GitBook often stores images in .gitbook/assets/. Move them to public/ and update references:
- 
+ From Mintlify
Barodoc’s configuration is designed to be familiar if you’ve used Mintlify.
Copy your content
Your MDX files can be used largely as-is. Copy them into docs/en/.
Convert mint.json to barodoc.config.json
The structure is very similar:
// mint.json → barodoc.config.json
{
- "name": "My Docs",
- "navigation": [
- { "group": "Guides", "pages": ["quickstart"] }
- ],
- "colors": { "primary": "#0070f3" }
+ "name": "My Docs",
+ "navigation": [
+ { "group": "Guides", "pages": ["quickstart"] }
+ ],
+ "theme": { "colors": { "primary": "#0070f3" } }
}Key differences:
- Colors are nested under
theme.colorsinstead of top-levelcolors anchors→ usetopbarfor external linkstabs→ use navigation groups
Update components
Most Mintlify components have direct equivalents:
| Mintlify | Barodoc |
|---|---|
<Note> / <Warning> / <Tip> | <Callout type="note"> / <Callout type="warning"> / <Callout type="tip"> |
<Card> / <CardGroup> | <Card> / <CardGroup> (same) |
<Tabs> / <Tab> | <Tabs> / <Tab> (same) |
<Steps> / <Step> | <Steps> / <Step> (same) |
<Accordion> | <Accordion> (same) |
<CodeGroup> | <CodeGroup> (same) |
<ParamField> | <ParamField> (same) |
<ResponseField> | <ResponseField> (same) |
<Expandable> | <Expandable> (same) |
Tip
Many Mintlify components work in Barodoc without any changes since Barodoc was designed with Mintlify API compatibility in mind.
Common Migration Tips
- Frontmatter is optional: If your file starts with
# Title, Barodoc extracts the title automatically — no frontmatter needed. - Static assets: Place images, fonts, and other assets in the
public/directory. - Plugins: Add search, analytics, sitemap, etc. via the
pluginsarray in config. - Testing: Run
barodoc checkto validate your docs structure after migration.