Install

Create a new docs site and deploy it.

Create your docs

  1. Create a new project using the GitHub template or the CLI:
    npm create reallysimpledocs@latest my-docs
# or: npx create-reallysimpledocs@latest my-docs
  2. Install dependencies:
    cd my-docs && npm install
  3. Start the dev server:
    npm run dev
  4. Open up the site at http://localhost:8080

You can then customize your site and write docs.

Deploy

Build the site with npm run build and upload _site/ to a static host:

Upgrade

This template is intentionally simple: the easiest “upgrade” flow is to scaffold a fresh copy and move your content back in.

  1. Scaffold a new copy (next version).
  2. Copy your content and config:
    • docs/
    • docs/docs.json
    • _data/site.json
    • media/ (if you use it)
  3. Re-apply any local customizations you made in:
    • _includes/
    • src/css/overrides.css