Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lalit2005/hyperdocs
Easiest way to build documentation for your project. No config or build required, hosted on @netlify.
https://github.com/lalit2005/hyperdocs
devtools documentation documentation-generator markdown nextjs planetscale prisma tailwindcss
Last synced: 4 days ago
JSON representation
Easiest way to build documentation for your project. No config or build required, hosted on @netlify.
- Host: GitHub
- URL: https://github.com/lalit2005/hyperdocs
- Owner: lalit2005
- License: mit
- Created: 2022-02-03T14:24:21.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-14T05:03:24.000Z (almost 2 years ago)
- Last Synced: 2024-10-27T23:23:20.695Z (14 days ago)
- Topics: devtools, documentation, documentation-generator, markdown, nextjs, planetscale, prisma, tailwindcss
- Language: TypeScript
- Homepage: https://hyperdocs.netlify.app
- Size: 5.81 MB
- Stars: 86
- Watchers: 2
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
README
Hyperdocs is the simplest way you can create documentation for your project. It blends the best of all the other documentation tools in one.
**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.
View demo [here](https://hyperdocs.netlify.app/hashnode/docs)
[Here's How I built Hyperdocs](https://lalit2005.hashnode.dev/hyperdocs)
## Some handly links
- Hyperdocs website - https://hyperdocs.netlify.app/
- GitHub Repo - https://github.com/lalit2005/hyperdocs
- Hyperdocs Documentation - https://hyperdocs.netlify.app/hyperdocs/docs
- Hyperdocs vs Docusaurus - https://hyperdocs.netlify.app/hyperdocs/docs/vs-docusaurus
## Features
- ✅ **No configuration** required.
- ✅ **No rebuilds** or dealing with hosting providers needed.
- ✅ Built in **blog** for your project.
- ✅ **Premade compoenents** for your docs such as callouts, tooltips, react live code preview, etc. all inside markdown.
- ✅ Built in **feedback collection widget**.
- ✅ Ability to add **custom domains**/subdomains for your site.
- ✅ Super fast documentation and blogs hosted on edge on **Netlify**.
- ✅ Use different themes and plugins to enhance the look and feel of your documentation.
- ✅ A beautiful homepage that can be customized.
- ✅ Auto updating docs site that fetches content from GitHub repo periodically.
- ✅ Dark mode for all pages.
- ✅ Ability to use jsx inside markdown.
- ✅ Dashboard to manage your docs site.
- ✅ Support for private repositories.
## Comparison
## Support
If you would like to support me, you can by me a coffee [here](https://www.buymeacoffee.com/lalitcodes)
## Stats
---
[Get started now (totally free) →](https://hyperdocs.netlify.app/signup)
