{"id":13599717,"url":"https://github.com/lalit2005/hyperdocs","last_synced_at":"2025-04-10T17:32:02.898Z","repository":{"id":38387979,"uuid":"455195467","full_name":"lalit2005/hyperdocs","owner":"lalit2005","description":"Easiest way to build documentation for your project. No config or build required, hosted on @netlify.","archived":false,"fork":false,"pushed_at":"2023-01-14T05:03:24.000Z","size":6097,"stargazers_count":86,"open_issues_count":1,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T21:34:52.192Z","etag":null,"topics":["devtools","documentation","documentation-generator","markdown","nextjs","planetscale","prisma","tailwindcss"],"latest_commit_sha":null,"homepage":"https://hyperdocs.netlify.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lalit2005.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-03T14:24:21.000Z","updated_at":"2024-09-11T08:58:35.000Z","dependencies_parsed_at":"2023-02-09T18:45:38.927Z","dependency_job_id":null,"html_url":"https://github.com/lalit2005/hyperdocs","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lalit2005%2Fhyperdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lalit2005%2Fhyperdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lalit2005%2Fhyperdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lalit2005%2Fhyperdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lalit2005","download_url":"https://codeload.github.com/lalit2005/hyperdocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248261994,"owners_count":21074229,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["devtools","documentation","documentation-generator","markdown","nextjs","planetscale","prisma","tailwindcss"],"created_at":"2024-08-01T17:01:09.746Z","updated_at":"2025-04-10T17:32:02.548Z","avatar_url":"https://github.com/lalit2005.png","language":"TypeScript","funding_links":["https://www.buymeacoffee.com/lalitcodes"],"categories":["TypeScript"],"sub_categories":[],"readme":"![image](https://user-images.githubusercontent.com/69138026/156125650-a2f7cd40-0a20-439d-bf1f-70c4c1da9227.png)\n\nHyperdocs is the simplest way you can create documentation for your project. It blends the best of all the other documentation tools in one.\n\n**Hyperdocs** requires no configuration and yet is highly customizable. You just need to have a bunch of markdown files in a /docs directory and Hyperdocs will take care of the rest.\n\nView demo [here](https://hyperdocs.netlify.app/hashnode/docs)\n\n[Here's How I built Hyperdocs](https://lalit2005.hashnode.dev/hyperdocs)\n\n## Some handly links\n\n- Hyperdocs website - https://hyperdocs.netlify.app/\n- GitHub Repo - https://github.com/lalit2005/hyperdocs\n- Hyperdocs Documentation - https://hyperdocs.netlify.app/hyperdocs/docs\n- Hyperdocs vs Docusaurus - https://hyperdocs.netlify.app/hyperdocs/docs/vs-docusaurus\n\n## Features\n\n- ✅ **No configuration** required.\n- ✅ **No rebuilds** or dealing with hosting providers needed.\n- ✅ Built in **blog** for your project.\n- ✅ **Premade compoenents** for your docs such as callouts, tooltips, react live code preview, etc. all inside markdown.\n- ✅ Built in **feedback collection widget**.\n- ✅ Ability to add **custom domains**/subdomains for your site.\n- ✅ Super fast documentation and blogs hosted on edge on **Netlify**.\n- ✅ Use different themes and plugins to enhance the look and feel of your documentation.\n- ✅ A beautiful homepage that can be customized.\n- ✅ Auto updating docs site that fetches content from GitHub repo periodically.\n- ✅ Dark mode for all pages.\n- ✅ Ability to use jsx inside markdown.\n- ✅ Dashboard to manage your docs site.\n- ✅ Support for private repositories.\n\n## Comparison\n\n![image](https://user-images.githubusercontent.com/69138026/164963852-ec3f5885-d4c6-42c2-b38c-ee76f1ffff28.png)\n\n## Support\n\nIf you would like to support me, you can by me a coffee [here](https://www.buymeacoffee.com/lalitcodes)\n\n## Stats\n\n![Stats](https://repobeats.axiom.co/api/embed/023417e740610fab743aadbd051ec40dad00c63f.svg 'Repobeats analytics image')\n\n---\n\n[Get started now (totally free) →](https://hyperdocs.netlify.app/signup)\n\n![image](https://user-images.githubusercontent.com/69138026/156126230-2dacf7bf-7d61-4ffd-a7f1-2e2632d83875.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flalit2005%2Fhyperdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flalit2005%2Fhyperdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flalit2005%2Fhyperdocs/lists"}