Introduction to EmberDocs
EmberDocs is a powerful documentation platform designed for developers and technical writers. This guide introduces you to the core concepts and philosophy behind the framework.
What is EmberDocs?
EmberDocs is a documentation framework that combines the best of modern web development with a focus on content quality. Built on Next.js, it provides:
- Fast performance - Static generation for near-instant page loads
- Great DX - Simple Markdown syntax with type-safe components
- Search-first - Full-text search that feels like magic
- Flexible versioning - Support for multiple documentation versions
Core Concepts
Documents
A document is a Markdown file with YAML frontmatter. Each document represents a page in your documentation.
yaml
---
title: "My Document"
slug: "my-document"
published: true
---
# Content hereNavigation
Documents are organized in a hierarchical structure. EmberDocs automatically generates navigation based on your file structure.
Search Index
The search index is built at compile time and served as a static JSON file. This means search works instantly without any backend.
Why EmberDocs?
For Writers
- Focus on content, not infrastructure
- Simple Markdown syntax
- Built-in versioning support
For Developers
- Full TypeScript support
- Extensible component system
- Free to self-host (source-available core)
Next Steps
Ready to get started? Check out the Installation Guide.