Skip to main content

​
Documentation Made Easy

Write docs in Markdown. Get a beautiful, searchable documentation site instantly. No complex configuration, no build headaches—just pure documentation.

​
What is EasyGoDocs?

EasyGoDocs is a modern documentation platform built with Next.js that simplifies technical documentation. Whether you’re documenting APIs, creating tutorials, or building knowledge bases, EasyGoDocs lets you focus on writing while it handles the presentation. The Philosophy: Documentation shouldn’t be harder than the code itself. Write in Markdown (or MDX), push your changes, and you’re done.

Zero Configuration

Drop your .mdx files in src/docs/ and they’re instantly live at /mdx/your-file. No routing config needed.

Hot Reload

See your changes instantly during development. Edit, save, and watch your docs update in real-time.

Beautiful by Default

Responsive design, dark mode, syntax highlighting, and animated components out of the box.

Community Driven

Part of GSSoC’25. Open source, built by the community, for the community.

​
Two Ways to Document

EasyGoDocs supports two documentation approaches: 
# Create a file
echo "# My Documentation\n\nContent here..." > src/docs/my-topic.mdx

# That's it! Available at /mdx/my-topic
Perfect for:
  • Quick tutorials
  • Installation guides
  • Getting started docs
  • Community contributions

​
2. JSON + TSX Template

For advanced use cases, define your documentation structure in JSON: 
// src/db/my-doc.json
{
  "id": "my-doc",
  "title": "My Documentation",
  "sidebar": [...],
  "toc": [...],
  "content": [...]
}
The platform renders it using a React component (src/components/documentation/documentation-component.tsx:207) with:
  • Collapsible sidebar navigation
  • Auto-generated table of contents
  • Smooth scrolling and active heading tracking
  • Mobile-responsive drawer
Build-time optimization: Run npm run generate-db-index to create a static index of all JSON docs for serverless deployments.

​
Key Features

1

Automatic Table of Contents

Headings are automatically extracted from your Markdown and displayed in a sticky sidebar. The active section highlights as you scroll.
2

Syntax Highlighting

Code blocks use prism-react-renderer for beautiful, themeable syntax highlighting across 100+ languages.
// Automatically highlighted!
const Component = () => {
  return <div>Hello World</div>
}
3

MDX Support

Embed React components directly in your documentation:
import { MyComponent } from './components'

# My Doc

<MyComponent interactive />
4

Responsive Design

Mobile-first design with adaptive layouts. Sidebar becomes a drawer on mobile, TOC adapts to screen size.

​
Tech Stack

Next.js 15

Latest App Router with React Server Components and streaming

TypeScript

Fully typed for better DX and fewer bugs

Tailwind CSS

Utility-first styling with custom design tokens

MDX

Markdown + JSX for interactive documentation

Radix UI

Accessible, unstyled component primitives

Framer Motion

Smooth animations and transitions

​
Who Is This For?

  • Open Source Projects: Beautiful docs for your GitHub repos
  • Developer Tools: API documentation and SDK guides
  • Technical Writers: Focus on content, not infrastructure
  • Learning Platforms: Tutorials, courses, and educational content
  • Internal Teams: Company wikis and knowledge bases
EasyGoDocs is actively developed as part of GSSoC’25. Features and APIs may change. Pin your version for production use.

​
Quick Navigation

Quickstart

Get your first documentation page live in 5 minutes

Features

Explore all capabilities and customization options

Contribute

Join the community and help improve EasyGoDocs

​
Community & Support

EasyGoDocs is a proud participant in GSSoC’25 (GirlScript Summer of Code). Contributions earn points toward the leaderboard!
First time contributing? We’re beginner-friendly! Check out our issues labeled good-first-issue to get started.

Ready to create amazing documentation?

Get Started →View on GitHub

Build docs developers (and LLMs) love

Get started for freeTalk to us