Skip to main content

Quick Start

Get up and running with our wiki in just a few minutes.

Browsing Content​

Using the Sidebar​

The sidebar on the left provides hierarchical navigation through all wiki content. Click on any section to expand it and see sub-pages.

Searching​

Use the search bar at the top of the page to quickly find content. Search supports:

  • Full-text search across all pages
  • Search highlighting
  • Keyboard shortcuts (Ctrl/Cmd + K)

Creating Content​

File Structure​

All wiki content is stored as Markdown files in the docs/ directory. The folder structure directly maps to the sidebar navigation.

docs/
├── intro.md              # Homepage
├── getting-started/      # Section folder
│   ├── _category_.json   # Section metadata
│   └── quick-start.md    # This page
└── guides/              # Another section
    └── ...

Writing in Markdown​

Pages are written in Markdown with support for:

  • Headers, lists, and formatting
  • Code blocks with syntax highlighting
  • Tables and blockquotes
  • Images and links
  • Custom React components (MDX)

Next Steps​