Creating Documentation

• Introduction
• Creating Documentation with Markdown

​

Introduction

Often one of the biggest challenges when starting a new project or application is creating and maintaining documentation for users and developers. Elegant provides a simple, and powerful tool for creating and managing beautiful documentation.

To learn more about the benefits of using Markdown, check out our more detailed writeup on the power of Markdown.

​

Creating Documentation with Markdown

To get started, create a new Markdown file, elegant.mdx, and place it under the src/pages/docs/ directory within your project.

website # root directory of your site
├── css
├── src
│    └── pages
│         └── docs
│              └── elegant.mdx
├── .env
├── next.config.js
├── package.json
├── tailwind.config.js
├── ...

Add the following Markdown to our sample elegant.mdx file.

---
title: Hello World
description: Create a beautiful documentation page with static rich content.
---

## Hello from Elegant

Are you ready to create beautiful documentation for your project or application?

### Headers

will show up on the table of contents on the upper right

So that your users will know what this page is all about without scrolling down or even without reading too much.