Getting Started
Welcome to your interactive documentation! This system allows you to create engaging documentation with live code examples.
Features
- Interactive Code: Execute TypeScript/JavaScript code directly in your documentation
- MDX Support: Write documentation in MDX format, combining Markdown with React components
- Customizable: Full control over styling and functionality
- Git-Friendly: Text-based format that works well with version control
Adding Your Own Documents
- Create
.mdx
files in your docs directory - Add frontmatter with a title
- Write your content using Markdown and React components
- Use the
Code
component for interactive code examples
Interactive Code Example
Hereβs a simple React component example:
TypeScript Example
Happy documenting! π