- Project Insights
- Live Demo
- easygodocs Vision
- Features
- Project Structure
- Getting Started
- Contribute
- Why EasyGoDocs
- Built With
- Deployment
- Logo
- Technology Stack
- Acknowledgments
- Contact
- How to Contribute
- Contributing
- Code of Conduct
- Contribution Guidelines
- Suggestions & Feedback
- Show Your Support
- License
- Stargazers
- Forkers
- Project Admin
Effortless, elegant, and powerful documentation for your Go projects.
| 🌟 Stars | 🍴 Forks | 🐛 Issues | 🔔 Open PRs | 🔕 Closed PRs | 🛠️ Languages | 👥 Contributors |
 |
 |
 |
 |
 |
 |
 |
Experience easygodocs live here:
👉
🌟 Exciting News...
🚀 This project is now an official part of GirlScript Summer of Code – GSSoC'25! 💃🎉💻 We're thrilled to welcome contributors from all over India and beyond to collaborate, build, and grow easygodocs! Let’s make learning and career development smarter – together! 🌟👨💻👩💻
👩💻 GSSoC is one of India’s largest 3-month-long open-source programs that encourages developers of all levels to contribute to real-world projects 🌍 while learning, collaborating, and growing together. 🌱
🌈 With mentorship, community support, and collaborative coding, it's the perfect platform for developers to:
- ✨ Improve their skills
- 🤝 Contribute to impactful projects
- 🏆 Get recognized for their work
- 📜 Receive certificates and swag!
🎉 I can’t wait to welcome new contributors from GSSoC 2025 to this easygodocs project family! Let's build, learn, and grow together — one commit at a time. 🔥👨💻👩💻
You can now write documentation in simple Markdown/MDX files! This is the easiest way to contribute:
- Add a new
.mdxfile insrc/docs/(e.g.,my-topic.mdx). - Write your content using Markdown headings (
#,##, etc.), lists, links, and even React components (with MDX). - Open a pull request—that's it! Your doc will be available at
/mdx/my-topic.
Example:
# My Topic
Welcome to my docs!
## Getting Started
- Step 1
- Step 2
## More Info
See [the guide](https://example.com).
Your doc will be automatically:
- ✅ Available at
/mdx/my-topic - ✅ Added to the table of contents
- ✅ Styled with beautiful typography
- ✅ Responsive on all devices
- ✅ Dark mode compatible
EasyGoDocs is designed to make documentation as easy and enjoyable as writing code.
Our mission is to empower teams and open-source communities to create, share, and maintain world-class documentation with minimal friction and maximum clarity.
- Minimalistic & Modern UI: Clean, distraction-free, and accessible by default.
- Go-First, but Flexible: Built for Go projects, but easily adaptable to any tech stack.
- Powered by Next.js & MDX: Enjoy fast, interactive docs with the flexibility of React and Markdown.
- Community-Driven: Contributions are easy, transparent, and celebrated.
- 📄 MDX & Markdown Support: Write docs in Markdown, extend with React components.
- 🧩 Component-Based: Modular, reusable UI for docs, guides, and API references.
- 🗂 Auto-Generated Navigation: Table of contents and sidebar generated from your headings.
- 🌗 Accessible & Responsive: Looks great on all devices, with a focus on accessibility.
- ⚡ Instant Preview: Hot reload and instant updates during development.
- 🔒 Ready for Auth: Example flows for protected docs and user guides.
- 🛠 Easy Customization: Theming, branding, and structure are all developer-friendly.
- 🚀 Vercel Ready: Optimized for deployment with static generation.
├── public/
│ └── easygodocs-logo.svg # Project logo (SVG, minimal, Figma-ready)
├── src/
│ ├── app/
│ │ ├── (main)/ # Main app routes and layouts
│ │ │ └── mdx/
│ │ │ └── [slug]/
│ │ │ └── page.tsx # MDX rendering (auto-generated routes)
│ │ ├── (nav-items)/ # Features, Pricing, About, Solution pages
│ │ ├── all-docs/ # Docs overview page
│ │ ├── contribution-guide/ # Contribution guide
│ │ └── ... # Other Next.js app routes
│ ├── components/
│ │ ├── documentation/ # Documentation rendering components
│ │ ├── page-components/ # Hero, footer, about, etc.
│ │ └── ui/ # Reusable UI (buttons, nav, etc.)
│ ├── docs/ # 📁 Your MDX files go here!
│ │ ├── react.mdx # ✅ Example: /mdx/react
│ │ ├── chrome-download.mdx # ✅ Example: /mdx/chrome-download
│ │ └── my-topic.mdx # ➕ Your new doc: /mdx/my-topic
│ ├── db/ # Legacy JSON docs (still supported)
│ └── lib/ # Utilities
├── scripts/
│ ├── generate-db-index.cjs # Legacy JSON index generator
│ └── generate-mdx-routes.cjs # MDX route generator for build
├── package.json
├── next.config.ts
└── vercel.json # Vercel deployment config
-
Install dependencies:
pnpm install # or npm install -
Run the development server:
pnpm dev # or npm run dev -
Open your browser:
Visit http://localhost:3000 to see EasyGoDocs in action. -
Add your first doc:
# Create a new MDX file touch src/docs/my-topic.mdx # Write your content and visit /mdx/my-topic
We love contributions! The process is now super simple:
- Create a new
.mdxfile insrc/docs/with a descriptive name - Write your content using standard Markdown
- Open a pull request—that's it!
- Edit any
.mdxfile insrc/docs/ - Fix typos, add sections, improve examples
- Submit your changes
- ✅ Table of Contents: Generated from your headings
- ✅ Responsive Design: Works on all devices
- ✅ Dark Mode: Automatic theme support
- ✅ Syntax Highlighting: For code blocks
- ✅ Search Integration: Your content is searchable
- ✅ Fast Loading: Static generation for performance
# My Documentation Title
Brief introduction to your topic.
## Getting Started
Step-by-step instructions:
1. First step
2. Second step
3. Third step
## Code Examples
```javascript
function example() {
console.log("Hello, World!");
}More detailed information...
Author: Your Name
Contributors: Team Members
For more details, see the Contribution Guide.
Note: We also maintain a Legacy JSON Contribution Guide for users who need to understand or work with the old JSON-based system.
- For maintainers: Keep docs up-to-date, beautiful, and easy to extend.
- For contributors: Add new docs with just a Markdown file—no complex setup.
- For users: Find what you need, fast, on any device.
- Next.js (App Router, MDX, Static Generation)
- Tailwind CSS (utility-first styling)
- Lucide Icons and React Icons
- Framer Motion (animations)
- TypeScript
- Shadcn
- MDX (Markdown + React)
EasyGoDocs is optimized for Vercel deployment:
# Build the project
pnpm run build
# Deploy to Vercel
vercel --prodThe build process automatically:
- ✅ Generates static routes for all MDX files
- ✅ Optimizes images and assets
- ✅ Creates production-ready bundle
- ✅ Handles all MDX compilation
Our logo is a minimal, modern document with a checkmark or arrow—representing clarity, completion, and the Go spirit.
See /public/easygodocs-logo.svg and variants in /public/.
Report bugs and issues or propose improvements through our GitHub repository's "Issues" tab.
- Firstly Star(⭐) the Repository
- Fork the Repository and create a new branch for any updates/changes/issue you are working on.
- Start Coding and do changes.
- Commit your changes
- Create a Pull Request which will be reviewed and suggestions would be added to improve it.
- Add Screenshots and updated website links to help us understand what changes is all about.
We welcome all contributions and suggestions! Whether it's a new feature, design improvement, or a bug fix - your voice matters 💜
Your insights are invaluable to us. Reach out to us team for any inquiries, feedback, or concerns.
EasyGoDocs is an original solution to the pain point of documentation—designed and built from the ground up to make documentation truly easy, beautiful, and maintainable for everyone.
- Special thanks to all contributors and the Go community!
- Special shoutout to GirlScript Summer of Code (GSSoC’25) for the amazing community and support!
- Built with dedication, collaboration, and lots of chai
- GitHub Issues: Report bugs or request features
- Email: Contact the maintainers for collaboration opportunities
Feel free to reach out with any questions or feedback!
We love contributions from the community! Whether it's a bug report, a new feature, or a documentation improvement, we appreciate your help.
How to Contribute
- Fork the repository and create a new branch for your changes.
- Make your changes and ensure everything is working as expected.
- Submit a pull request with a clear description of your changes.
Found a Bug?
- Check the issue tracker to see if the bug has already been reported.
- If not, open a new issue and provide as much detail as possible.
Have a Feature Idea?
- We'd love to hear it! Open an issue to discuss your idea.
We welcome contributions from developers of all skill levels! Here are some ways you can contribute:
- 🐛 Bug fixes - Help us identify and fix bugs
- ✨ New features - Suggest and implement new functionality
- 📚 Documentation - Improve our docs and guides
- 🎨 UI/UX improvements - Make the platform more user-friendly
- 🔧 Performance optimizations - Help make easygodocs faster and more efficient
- 📱 Mobile responsiveness - Improve the mobile experience
- 🔒 Security enhancements - Help keep user data safe
Thank you to everyone who has made easygodocs better! 💚
Please refer to the Code of Conduct for details on contributing guidelines and community standards.
We love our contributors! If you'd like to help, please check out our CONTRIBUTE.md file for guidelines.
Thank you once again to all our contributors who has contributed to easygodocs! Your efforts are truly appreciated. 💖👏
See the full list of contributors and their contributions on the GitHub Contributors Graph.
Feel free to open issues or discussions if you have any feedback, feature suggestions, or want to collaborate!
If you find easygodocs project helpful, give it a star! ⭐ to support more such educational initiatives:
- ⭐ Starring the repository
- 🐦 Sharing on social media
- 💬 Telling your friends and colleagues
- 🤝 Contributing to the project
This project is licensed under the MIT License - see the License file for details.
 Oindil Golder 
|
| Role | Name | GitHub Profile | LinkedIn Profile |
|---|---|---|---|
| Mentor 1 | Hussnain Ahmad | itspsychocoder | Hussnain-Ahmad |
Open an Issue | 🌟 Star on GitHub | 🚀 Live Demo
Ready to show off your coding achievements? Get started with easygodocs today! 🚀
EasyGoDocs — Documentation made easy.