{"id":29028480,"url":"https://github.com/rit3zh/modern-docs-template","last_synced_at":"2026-05-08T10:34:26.327Z","repository":{"id":300938965,"uuid":"1007658607","full_name":"rit3zh/modern-docs-template","owner":"rit3zh","description":"🗂️ My go-to documentation setup for every project built with 🧠 Fumadocs and ⚡ Next.js. Minimal, customizable, and designed for devs who actually care about good docs.","archived":false,"fork":false,"pushed_at":"2025-06-25T06:30:32.000Z","size":3467,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-09T09:27:49.332Z","etag":null,"topics":["docs","docs-template","fumadocs","next","react"],"latest_commit_sha":null,"homepage":"https://modern-docs-template.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rit3zh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-24T10:30:15.000Z","updated_at":"2025-09-01T10:52:10.000Z","dependencies_parsed_at":"2025-06-24T11:48:17.543Z","dependency_job_id":null,"html_url":"https://github.com/rit3zh/modern-docs-template","commit_stats":null,"previous_names":["rit3zh/modern-docs-template"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rit3zh/modern-docs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rit3zh%2Fmodern-docs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rit3zh%2Fmodern-docs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rit3zh%2Fmodern-docs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rit3zh%2Fmodern-docs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rit3zh","download_url":"https://codeload.github.com/rit3zh/modern-docs-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rit3zh%2Fmodern-docs-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32776880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"ssl_error","status_checked_at":"2026-05-08T08:22:45.650Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","docs-template","fumadocs","next","react"],"created_at":"2025-06-26T07:11:41.445Z","updated_at":"2026-05-08T10:34:26.308Z","avatar_url":"https://github.com/rit3zh.png","language":"TypeScript","funding_links":["https://buymeacoffee.com/rit3zh"],"categories":[],"sub_categories":[],"readme":"\u003c!-- Banner --\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/doc_page.png\" width=\"100%\" alt=\"Docs Template Banner\" /\u003e\n\u003c/p\u003e\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/home.png\" width=\"100%\"/\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/components.png\" width=\"100%\"/\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp\u003e\n    \u003cimg src=\"https://img.shields.io/badge/version-1.0.0-blue.svg\" alt=\"Version\" /\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-MIT-green.svg\" alt=\"License\" /\u003e\n    \u003cimg src=\"https://img.shields.io/badge/build-passing-brightgreen.svg\" alt=\"Build Status\" /\u003e\n    \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-purple.svg\" alt=\"PRs Welcome\" /\u003e\n  \u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"http://forthebadge.com/images/badges/built-with-love.svg\" alt=\"Built with love\" width=\"120px\" /\u003e\n\u003c/p\u003e\n\u003c/div\u003e\n\n\u003ch1 align=\"\"\u003e📘 Modern Doc Template\u003c/h1\u003e\n\n\u003cp align=\"\"\u003eA minimalist documentation system built with \u003cb\u003eNext.js\u003c/b\u003e and powered by \u003ca href=\"https://fumadocs.dev/\" target=\"_blank\"\u003e\u003cb\u003eFumadocs\u003c/b\u003e\u003c/a\u003e.\u003c/p\u003e\n\n✨ [Check out the live demo by clicking here!](https://modern-docs-template.vercel.app/)\n\n## ⚙️ Getting Started\n\nInstall dependencies and run the development server:\n\n```bash\n$ git clone https://github.com/rit3zh/modern-docs-template\n$ cd modern-docs-template\n```\n\nRunning the development server\n\n```bash\n$ pnpm install\n$ pnpm dev\n```\n\nVisit [http://localhost:3000](http://localhost:3000) in your browser.\n\n## 📁 Project Structure\n\n```bash\n.\n├── app/\n│   ├── (home)/              # Landing and custom pages\n│   ├── docs/                # MDX-based documentation\n│   └── api/search/          # Search API route\n├── lib/source.ts            # Fumadocs content adapter (loader)\n├── layout.config.tsx        # Layout options\n├── source.config.ts         # MDX config (frontmatter, sidebar, etc.)\n```\n\n---\n\n## ✍️ How to Write Docs\n\n1. Create `.mdx` pages inside the `app/docs/` folder.\n   Example:\n\n   ```bash\n   app/docs/guide/getting-started.mdx\n   ```\n\n2. Customize sidebar, groups, and ordering in `source.config.ts` using `defineConfig()`.\n\n3. Use Fumadocs UI components directly in your MDX:\n\n   ```mdx\n   import { Card } from \"fumadocs-ui/components/card\";\n\n   \u003cCard title=\"Welcome\" href=\"/docs/start\" /\u003e\n   ```\n\nLearn more in the [Fumadocs MDX Guide →](https://fumadocs.dev/docs/mdx)\n\n---\n\n## 🛠 Customization\n\n| Feature    | How to Customize                                    |\n| ---------- | --------------------------------------------------- |\n| Branding   | Update logo, favicon, meta in `app/layout.tsx`      |\n| Navigation | Edit sidebar/nav in `source.config.ts`              |\n| Theme      | Light/dark support is built-in                      |\n| Search     | Tweak `app/api/search/route.ts` for search behavior |\n\n---\n\n## 📚 Learn More\n\n- 🔗 [Fumadocs Documentation](https://fumadocs.dev)\n- 🔗 [Next.js Documentation](https://nextjs.org/docs)\n- 🔗 [Learn Next.js](https://nextjs.org/learn)\n\n---\n\n## 💬 Community \u0026 Support\n\n- 🐙 GitHub: [github.com/rit3zh/modern-doc-template](https://github.com/rit3zh/modern-doc-template)\n- 💬 Discord: [Rit3zh](http://discordapp.com/users/755101874268536893)\n- ☕ Buy Me a Coffee: [buymeacoffee.com/rit3zh](https://buymeacoffee.com/rit3zh)\n\n\u003e Built with ❤️ by [rit3zh](https://github.com/rit3zh) — clean, fast, and fully extensible.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frit3zh%2Fmodern-docs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frit3zh%2Fmodern-docs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frit3zh%2Fmodern-docs-template/lists"}