Basic Usage
Learn the fundamental concepts and workflows for using EmberDocs.
Creating Documents
Every document is a Markdown file with a YAML frontmatter block at the top:
markdown
---
title: "My Document"
slug: "my-document"
published: true
date: "2026-01-02"
tags: ["example", "documentation"]
---
# Document content goes hereFrontmatter Fields
| Field | Type | Description |
|---|---|---|
title | string | Display title for the document |
slug | string | URL-safe identifier |
published | boolean | Whether to include in navigation |
date | string | Publication date (ISO format) |
tags | array | Document tags for categorization |
order | number | Sort order in navigation |
author | string | Document author |
Writing Markdown
EmberDocs supports standard Markdown with GitHub-flavored extensions:
Headings
markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4Lists
Unordered List:
markdown
- Item 1
- Item 2
- Nested item
- Another nested itemOrdered List:
markdown
1. First step
2. Second step
3. Third stepCode Blocks
Inline code: const x = 5;
Code block with syntax highlighting:
typescript
const greet = (name: string): string => {
return `Hello, ${name}!`;
};Links
markdown
[Internal link](/docs/guides/basic-usage)
[External link](https://example.com)Organization
Organize your documents in directories:
text
docs/
āāā index.md
āāā getting-started/
ā āāā introduction.md
ā āāā installation.md
āāā guides/
āāā basic-usage.md
āāā advanced-features.mdEmberDocs automatically generates navigation based on this structure.
Metadata
Access document metadata in your components:
typescript
const parsed = parseMarkdown(content);
console.log(parsed.frontmatter.title); // "My Document"
console.log(parsed.toc); // Table of contents
console.log(parsed.body); // Markdown bodyTable of Contents
EmberDocs automatically generates a table of contents from headings. Just write natural headings in your content.
Next Steps
- Learn about Advanced Features
- Explore the API Reference