Quick Start#

Get your first documentation page live in under 5 minutes.

Create a New Page#

Add a new markdown file to the content/ directory:

---
title: My New Page
description: A brief description
layout: docs
---

# My New Page

Your content here.

Each page starts with YAML frontmatter:

Field	Description
`title`	Page title (used in header and navigation)
`description`	Brief description for meta tags
`layout`	Layout to use (`docs` for documentation)
`previous`	Optional link to previous page
`next`	Optional link to next page

The documentation supports standard Markdown plus:

Use triple backticks with a language identifier:

void main() {
  print('Hello, Jaspr!');
}

Headings automatically get anchor links and appear in the table of contents.

Both internal and external links work:

Edit lib/components/docs_sidebar.dart to add your page to the navigation:

SidebarItem(
  label: 'My New Page',
  icon: Icons.file,
  href: '/docs/my-new-page',
  active: currentPath == '/docs/my-new-page',
),

Build and deploy to any static hosting:

jaspr build
# Upload build/jaspr/ to your host