Skip to content

Docs site

Developer docs use VitePress in docs/.

bash
npm run docs:dev
npm run docs:build
npm run docs:preview

Deploy

Docs are published to GitHub Pages only:

https://thaikolja.github.io/nuxt-toc/

Workflow: .github/workflows/docs.yml

  • Trigger: push to main that touches docs/** (or manual Actions → docs → Run workflow)
  • Build uses base: /nuxt-toc/
  • Local docs:dev uses base: /

Setup once

  1. Repo Settings → Pages → Source: GitHub Actions
  2. Push docs changes to main

No Cloudflare or monorepo tokens are required.

Logo: docs/public/logo.png (copied from root logo.png).

Released under the MIT License.