Write Docs in Markdown. That's It!

Anyone can help make EasyGoDocs better. Just write in Markdown and we'll handle the rest!

How to Add Documentation (3 Simple Steps)

Create a new .mdx file in src/docs/ (e.g., my-topic.mdx).
Write your content using Markdown headings (#, ##, etc.), lists, links, and even React components.
Open a Pull Request—that's it! Your doc will be available at /mdx/my-topic.

src/docs/<your-topic>.mdx→/mdx/<your-topic>

Example Documentation

Here's a simple example of what your .mdx file should look like:

# My Topic

Welcome to my documentation!

## Getting Started

- Step 1: Install the package
- Step 2: Configure settings
- Step 3: Start building

## Advanced Usage

You can use **bold text**, *italic text*, and `code snippets`.

### Code Example

```javascript
function hello() {
  console.log("Hello, world!");
}
```

## More Information

See [the official guide](https://example.com) for more details.

---

**Author:** Your Name  
**Contributors:** Team Members

What You Get Automatically

Table of Contents: Generated automatically from your headings
Sidebar Navigation: Your doc appears in the docs list automatically
Responsive Design: Looks great on all devices
Syntax Highlighting: Code blocks are automatically styled
Dark Mode Support: Works with the site's theme
Search Integration: Your content is searchable

Project Structure

├── src/
│   ├── docs/                    # 📁 Your MDX files go here
│   │   ├── react.mdx           # ✅ Example: /mdx/react
│   │   ├── my-topic.mdx        # ➕ Your new doc: /mdx/my-topic
│   │   └── ...
│   ├── app/
│   │   └── (main)/
│   │       └── mdx/
│   │           └── [slug]/
│   │               └── page.tsx # 🚀 Renders your MDX files
│   └── components/
│       └── documentation/       # 🧩 UI components for docs
└── package.json

MDX Features You Can Use

Markdown Features

Headings (#, ##, etc.)
Lists (ordered and unordered)
Links and images
Code blocks with syntax highlighting
Tables
Blockquotes

React Components

Interactive components
Custom UI elements
Embedded demos
Dynamic content
Custom styling

Pro Tips for Contributors

Use descriptive filenames (e.g., docker-setup.mdx).
Start with a clear H1 heading that describes your topic.
Use H2 and H3 headings to organize your content logically.
Include code examples with proper syntax highlighting.
Add links to related resources and official documentation.
Keep your content clear, concise, and beginner-friendly.
Test your MDX locally before submitting a PR.

🆕 New Contribution Method

We've simplified the contribution process! Instead of creating JSON files and page components, you can now just write Markdown/MDX files. This makes it much easier for everyone to contribute.

The old JSON-based method is still supported for existing docs, but new contributions should use the MDX approach described above. Learn about the legacy JSON method.

You're Awesome!

Thanks for making EasyGoDocs better. Every line of documentation helps the community! 🚀