Guide
Site Structure
How GlobalDocs Atlas organises pages, navigation, content, and search — and how to extend it.
How pages work
Each page is a self-contained HTML file. No server, no build process, no shared state. The browser loads each file directly. Every page has three sections: Topbar (brand, search, theme toggle), Sidebar (navigation, same across all pages), and Content area (unique per page).
File structure
globaldocs-atlas/
├── index.html ← Introduction
├── quick-start.html
├── guide-structure.html ← This page
├── guide-customise.html
├── guide-deploy.html
├── ref-components.html
├── ref-tokens.html
├── demo-api.html
├── demo-saas.html
├── pagefind/ ← Generated by search indexer
├── README.md
└── LICENSE.txt
The
pagefind/ folder is generated when you run npx pagefind --site .. It does not exist on first download. Include it when deploying.
Navigation groups
| Group | Purpose |
|---|---|
| Getting Started | Onboarding pages — the first thing new users read |
| Guides | How-to content — explains how to accomplish specific tasks |
| Reference | Technical reference — components, tokens, API |
| Demo Templates | Example pages showing the template in context |
Adding a new page
- Duplicate any existing
.htmlfile - Rename it (e.g.
guide-billing.html) - Change the
<title>tag - Replace content inside
<div class="content"> - Add a link in the sidebar of every page
- Set
class="nav-link active"only in the new file - Update breadcrumb and prev/next buttons
- Run
npx pagefind --site .to index the new page
Naming conventions
| Prefix | Use for | Example |
|---|---|---|
guide- | How-to content | guide-billing.html |
ref- | Technical reference | ref-webhooks.html |
demo- | Example pages | demo-enterprise.html |
| No prefix | Top-level pages | changelog.html |