Documentation

Create and manage documentation with multi-language support and SEO'

Tools

Setup

  1. Create a markdown file:
    • Add a new Markdown file under content/docs for your default language.
    • For other languages:
      • Define a new collection in content.config.ts with the appropriate source for that locale.
      • Create a folder for the locale (e.g., content/es/docs) and add a Markdown file inside it.
  2. Markdown Content:
    content/docs/new-doc.md or content/docs/en/new-doc.md
    
    ---
    
    title: My New Documentation
    description: Step-by-step guide for this document.
    
    ---
    
    ## Introduction
    
    This is the content of your document.
    
  3. View and Verify the Document:
    • Go to /docs to see the blog list with titles, descriptions, thumbnails, and categories.
    • Open your new document at /docs/my-new-doc to confirm it renders correctly.

Folder Structure

content/
├─ docs/
│  ├─ 1.get-started/
│  │  ├─ .navigation.yml
│  │  └─ 1.index.md
│  └─ 2.essentials/
│     ├─ .navigation.yml
│     └─ 1.markdown-syntax.md
└─ es/
   └─ docs/
      ├─ 1.get-started/
      │  ├─ .navigation.yml
      │  └─ 1.index.md
      └─ 2.essentials/
         ├─ .navigation.yml
         └─ 1.markdown-syntax.md