MarkDocs

Getting Started

Learn how to use MarkDocs

Installation

MarkDocs is already set up and ready to use!

Creating Content

Create new MDX files in the content/docs directory:

content/docs/my-page.mdx
---
title: My Page
description: Page description
---

## My Heading

Content goes here...

Frontmatter

Each MDX file should have frontmatter at the top:

  • title - The page title
  • description - The page description (for SEO and page metadata)
  • full - (optional) Set to true for full-width pages

MDX Components

You can use all standard Markdown syntax plus React components in your MDX files.

Using UI Library Components

You can import and use components from the @edstack/ui-library package:

Custom Components

You can also create custom React components and use them in your MDX files:

🚀

Easy to Use

MarkDocs makes it simple to create beautiful documentation with MDX and React components.

🎨

Fully Customizable

Build custom components and use them anywhere in your documentation.