Documentation Map
Every page in this documentation set with path and purpose.
Getting Started
| Path | Purpose |
|---|---|
| getting-started/index.md | Section landing: prerequisites to first build |
| getting-started/prerequisites.md | Environment requirements (Node.js 18+) |
| getting-started/installation.md | Install core and plugins, bootstrap project |
| getting-started/quickstart.md | Fastest path from empty folder to running site |
| getting-started/core-concepts.md | Mental model: content, templates, plugins, build |
| getting-started/project-structure.md | Expected directory layout |
Tutorials
| Path | Purpose |
|---|---|
| tutorials/index.md | Section landing: sequential learning path |
| tutorials/step-1-create-your-first-project.md | Create project, install deps, bootstrap |
| tutorials/step-2-configure.md | Edit site.json with identity and plugins |
| tutorials/step-3-run-locally.md | Build and preview with dev server |
| tutorials/step-4-build-for-production.md | Production build with minification |
| tutorials/step-5-deploy.md | Deploy static output |
| tutorials/step-6-add-your-first-plugin.md | Add and verify a plugin |
Guides
| Path | Purpose |
|---|---|
| guides/index.md | Section landing: task-oriented guides |
| guides/configuration.md | Practical config editing guidance |
| guides/cli-usage.md | CLI commands and workflow |
| guides/troubleshooting.md | Common errors and fixes |
| guides/faq.md | Frequently asked questions |
Deploy
| Path | Purpose |
|---|---|
| deploy/index.md | Section landing: deployment options |
| deploy/local-build-and-preview.md | Local preview before deployment |
| deploy/production-build.md | Production-ready build settings |
| deploy/deploy-options-overview.md | Platform comparison and evidence |
| deploy/github-pages.md | GitHub Pages deployment |
| deploy/netlify.md | Netlify deployment (inferred) |
| deploy/vercel.md | Vercel deployment (inferred) |
| deploy/aws-amplify.md | AWS Amplify deployment (inferred) |
| deploy/docker.md | Docker containerized serving (inferred) |
| deploy/ci-cd.md | CI/CD pipeline patterns |
Extend
| Path | Purpose |
|---|---|
| extend/index.md | Section landing: plugin system and authoring |
| extend/plugin-system-overview.md | Discovery, hooks, context, error handling |
| extend/plugin-lifecycle.md | Hook order and per-hook context matrix |
| extend/plugin-api-reference.md | Contract types and minimal skeleton |
| extend/your-first-plugin.md | Hands-on plugin authoring tutorial |
| extend/plugin-cookbook.md | Common patterns and best practices |
| extend/plugins/index.md | Plugin catalog landing page |
| extend/plugins/plugin-robots-txt.md | Robots.txt generation plugin |
| extend/plugins/plugin-tailwindcss.md | Tailwind CSS compilation plugin |
| extend/plugins/plugin-esbuild.md | JavaScript bundling plugin |
| extend/plugins/plugin-rss.md | RSS feed generation plugin |
| extend/plugins/plugin-sitemap.md | Sitemap generation plugin |
| extend/plugins/plugin-content-bridge.md | External API content bridge plugin |
| extend/plugins/plugin-open-graph.md | OG/Twitter/JSON-LD metadata plugin |
Reference
| Path | Purpose |
|---|---|
| reference/index.md | Section landing: technical reference |
| reference/architecture-overview.md | System architecture summary |
| reference/configuration-reference.md | Complete config field reference |
| reference/cli-reference.md | CLI flags and dispatch behavior |
| reference/important-types.md | TypeScript type contracts |
| reference/glossary.md | Terminology and abbreviations |
| reference/documentation-map.md | This page |
Top Level
| Path | Purpose |
|---|---|
| index.md | Documentation home and navigation hub |