Quickstart

Before you begin

• A GitHub account
• Git installed locally
• Node.js (to run the CLI via npx)

• Scaffold your docs files

  Open a terminal at your project root (an empty folder or an existing repository) and run:

  npx @docs.page/cli init

  Information

  Windows (PowerShell): use npx '@docs.page/cli' init — PowerShell requires quotes around the package name.

  The CLI asks for your project name and whether to create starter pages. Accept the defaults unless you already have a docs/ directory you want to keep. See CLI for install options and flags.

  When init finishes, your project contains:

  docs.json
  docs/
    index.mdx
    next-steps.mdx

  • docs.json: site configuration (name, description, sidebar, and theme)
    • docs/index.mdx: your home page (served at /)
    • docs/next-steps.mdx: a second page (served at /next-steps)

  Open docs/index.mdx and change the title or add a sentence so you can confirm your changes later on the live site.

• Push to a public GitHub repository

  docs.page only hosts public repositories. Commit and push from your project directory:

  git add docs.json docs/
  git commit -m "Add docs.page site"
  git push

  Warning

  If the repository is private, docs.page returns an error and does not serve your documentation. Make the repository public before opening your live URL.

• Open your live site

  Your documentation is live the instant your push completes. Open your browser and navigate to:

  https://docs.page/{owner}/{repo}

  For example, if your repository is https://github.com/acme/my-docs, your live site is https://docs.page/acme/my-docs.

  Pushes to your default branch update this URL automatically with no build step. See Public GitHub hosting for how production URLs work.

• Write: structure pages, add code examples, and use built-in components
• Organize: order sidebar groups, tabs, and page links in docs.json
• Preview: iterate on content locally before pushing; see Local preview for how the preview shell works
• Agent-ready docs: llms.txt, MCP, and optional Ask AI on your live site