Use it for your own docs

Everything specific to a site lives in two places — feastdocs.config.mjs and the docs/ folder. Start from the template and both are already empty of this site's content.

1. Start from the template #

git clone https://github.com/Mindfeast/feastdocs-template.git my-docs
cd my-docs
rm -rf .git && git init && git add -A && git commit -m "Initial commit"
git remote add origin https://github.com/your-org/my-docs.git
git push -u origin main

npm install
npm start

2. Configure the site #

Everything is in feastdocs.config.mjs:

export default {
  title: 'My Product Docs',
  tagline: 'Everything about My Product.',

  theme: {
    defaultMode: 'dark',
    accent: '#2f6fdb',
    accentDark: '#6ba1f4',
  },

  // "Edit this page" links on every page:
  editUrl: 'https://github.com/your-org/my-docs/edit/main/docs/',

  // Web editing: lets the content manager commit to your repo:
  github: {
    repo: 'your-org/my-docs',
    branch: 'main',
  },
};

3. Replace the content #

Delete the template's sections and write your own — every top-level folder in docs/ becomes a navbar tab (Pages & sections):

docs/
├── index.md              your landing page
├── getting-started/
│   ├── _section.json     { "label": "Getting started", "position": 1 }
│   └── index.md
└── api/
    ├── _section.json     { "label": "API", "position": 2 }
    └── index.md

4. Deploy #

npm run build produces plain static files in dist/feastdocs/browser/ — prerendered HTML per page, hashed assets, sitemap.xml, robots.txt. Any static host serves them.

One rule applies to every target: requests that match no file must fall back to index.html, because routing happens in the browser. Without it, deep links work on first click and 404 on refresh. Every config below does that.

docker build -t my-docs .
docker run -p 8080:80 my-docs

docker tag my-docs registry.example.com/my-docs:1.0.0
docker push registry.example.com/my-docs:1.0.0

variables:
  registryConnection: my-registry-connection
  imageRepository: feastdocs

npm ci
npm run build
sudo cp -r dist/feastdocs/browser/* /var/www/my-docs/

server {
  listen 80;
  server_name docs.example.com;
  root /var/www/my-docs;

  location / {
    try_files $uri $uri/index.html /index.html;
  }
}

sudo nginx -t && sudo systemctl reload nginx

npm ci
npm run build
Copy-Item deploy/web.config dist/feastdocs/browser/web.config
Copy-Item -Recurse -Force dist/feastdocs/browser/* C:/inetpub/my-docs/

Serving from a subpath #

All of the above assume the docs sit at the root of a domain. To host them under a path instead, build with a matching base href:

npx ng build --base-href /docs/

5. Optional: "Sign in with GitHub" for web editing #

Web editing works out of the box with personal access tokens. For a real OAuth login button, three steps (the exchange function already ships in functions/):

1. Create a GitHub OAuth App (Settings → Developer settings → OAuth Apps) with callback URL https://your-site/_editor.
2. Set github.oauthClientId in feastdocs.config.mjs to the app's client id.
3. Add GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET as secrets on the Cloudflare Pages project (Settings → Variables and secrets).

Editing rights are always the repository's collaborator permissions — GitHub enforces them on every commit, whoever is signed in.

6. Choose how people edit #

Both strategies work at the same time; see the content manager for the full picture:

Either way the history is git, so "last updated by" under every page stays truthful — it is read from the commits at build time.