Getting Started

The project reads files directly from your GitHub repository. To get started:

  1. Create a docs directory to any public GitHub repository.
  2. Create an index.mdx file.
  3. Add some Markdown content.
  4. View your documentation.

The documentation is available by providing the repositories owner and name after the domain:


Working with Markdown#

The project supports rendering all GitHub-flavored Markdown.

Under the hood, MDX is enabled which allows the use of Custom Components. Each Markdown page also supports Frontmatter, allowing you to customize the metadata of each specific page.

Configuring your documentation#

By default, will render a single page with default configuration options. Although there is nothing wrong with this, you can further enhance the functionality of the generated documentation by creating a docs.json file at the root of your repository:

  "name": "Awesome Project",
  "theme": "#ab47bc",
  "favicon": "/assets/favicon.ico",
  "logo": "",
  "docsearch": {
    "appId": "...",
    "apiKey": "...",
    "indexName": "..."

Once committed, will first read the configuration and update the website. To learn more about the available configuration options, view the documentation.