← Docs

Project Structure

How to organize your markdown files for best results.

GetPagemark generates your site structure directly from your file and folder layout. No config files needed.

Basic Example

my-docs/
├── index.md              → /  (homepage)
├── getting-started.md    → /getting-started
├── faq.md                → /faq
├── guide/
│   ├── index.md          → /guide  (section landing)
│   ├── installation.md   → /guide/installation
│   └── configuration.md  → /guide/configuration
└── api/
    ├── overview.md        → /api/overview
    └── endpoints.md       → /api/endpoints

Rules

  • index.md in any folder becomes the landing page for that section.
  • Folders become collapsible sections in the sidebar.
  • Files are sorted by the order frontmatter field (ascending), then alphabetically by title.
  • Hidden directories (starting with .) and node_modules are ignored.
  • File names are converted to title case for nav labels: getting-started.md → "Getting Started".

Clean URLs

Every page gets a clean URL. guide/installation.md becomes /guide/installation — no .html extension needed.

Nesting Depth

You can nest folders as deep as you want. Each level adds indentation in the sidebar navigation. Keep it to 2-3 levels for the best reading experience.