Easiest way to build documentation for your project. No config or build required, hosted on @netlify.

Related tags

Learning resource markdown documentation nextjs devtools documentation-generator prisma tailwindcss planetscale
Overview

image

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

Here's How I built Hyperdocs

Some handly links

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

image

Support

If you would like to support me, you can by me a coffee here

Stats

Stats

Get started now (totally free) →

image

Comments
  • Updated Packages

    Updated Packages

    Hey, @Lalit2005

    The Packages weren't updated so simply fixed them as well as there were 6 vulnerabilities as detected by npm, fixed them as well.

    Kind Regards, Devarshi Shimpi

    opened by devarshishimpi 2
  • Auto spell check docs' content

    Auto spell check docs' content

    What this PR does

    Spell check content before parsing them into MDX and notify user via email about the error

    Todo

    • [ ] Spellcheck with https://www.npmjs.com/package/spellchecker
    • [ ] Notify users via email with web3forms

    Thanks to @shaloo for the idea.

    opened by Lalit2005 2
  • chore(deps): bump minimist from 1.2.5 to 1.2.6

    chore(deps): bump minimist from 1.2.5 to 1.2.6

    Bumps minimist from 1.2.5 to 1.2.6.

    Commits

    Dependabot compatibility score

    Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

    Dependabot commands and options

    You can trigger Dependabot actions by commenting on this PR:

    • @dependabot rebase will rebase this PR
    • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
    • @dependabot merge will merge this PR after your CI passes on it
    • @dependabot squash and merge will squash and merge this PR after your CI passes on it
    • @dependabot cancel merge will cancel a previously requested merge and block automerging
    • @dependabot reopen will reopen this PR if it is closed
    • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
    • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
    • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
    • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
    • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
    • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
    • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
    • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

    You can disable automated security fix PRs for this repo from the Security Alerts page.

    dependencies 
    opened by dependabot[bot] 1
  • [ImgBot] Optimize images

    [ImgBot] Optimize images

    Beep boop. Your images are optimized!

    Your image file size has been reduced by 18% 🎉

    Details

    | File | Before | After | Percent reduction | |:--|:--|:--|:--| | /public/ogimage.png | 24.68kb | 8.89kb | 63.97% | | /public/favicon.png | 2.16kb | 1.47kb | 32.01% | | /public/landing-page-image.png | 1,060.58kb | 836.31kb | 21.15% | | /public/feedbacks.png | 348.23kb | 305.69kb | 12.22% | | /public/blogs.png | 267.00kb | 245.72kb | 7.97% | | /public/vercel.svg | 1.08kb | 1.06kb | 1.00% | | | | | | | Total : | 1,703.73kb | 1,399.14kb | 17.88% |

    📝 docs | :octocat: repo | 🙋🏾 issues | 🏪 marketplace

    ~Imgbot - Part of Optimole family

    opened by imgbot[bot] 1
  • typo fix and query why-web3forms.md

    typo fix and query why-web3forms.md

    typo fix. Query - is there a spellchecker that comes bundled with hyper docs or a third party one that can be enabled? For e.g., Sphinx has extensions available such as sphinxcontrib-spelling that can be plugged in and spell check automated.

    opened by shaloo 1
  • The hyperdocs website is not mobile responsive

    The hyperdocs website is not mobile responsive

    Hey @Lalit2005, the hashnode website doesn't seems to fit the viewport on the mobile devices.

    I would like to work on this issue. Let me know if that's fine with you.

    opened by Logan1x 1
Releases(v0.0.7)

  • v0.0.7(Mar 23, 2022)

  • v0.0.6(Mar 23, 2022)

    • fix: remove h1 tags in default files in cli 3473c42
    • refactor: add buymeacoffee link in readme 83ce917
    • refactor: update readme 6df19c9
    • docs: add hyperdocs intro video in docs 892f8e4
    • docs: add loom component docs 7d59c90
    • feat: add new loom video embedding component 8681d42
    • fix: button type 581976b
    • fix: typo and btn placement e79d443
    • feat: add deleting blogs feature 6e4aa28
    • fix: autogenerate proper slugs for new blogs c2da2a1
    • perf: merge pull request #3 from Lalit2005/imgbot 759464f
    • fix: merge pull request #4 from realtouseef/small-ui-changes eb21933
    • [ImgBot] Optimize images 8d6449f
    • Merge branch 'master' of https://github.com/Lalit2005/hyperdocs a4ad393
    • fix: link 3c6b63e
    • fixed scrollbar showing on x-axis alongside the login button showing twice on smaller screens d7f82f8
    • refactor: update homepage image 7530fd1
    • feat: add google site verification tag 5a6553a
    • fix: typo. merge pull request #1 from shaloo/patch-1 c1c237d
    • fix: typos 2cedd7b
    • feat: add gitpod.yml d2d58a8
    • Update why-web3forms.md d61ec43
    • fix: typo c626e7e
    • Merge branch 'master' of https://github.com/Lalit2005/hyperdocs e4983e4
    • docs: add more info for custom domains 0edbd84
    • docs: fix link c56d680
    • fix: z-index of navbar in docs b9df35d
    • refactor: create license 2fb9018
    • refactor: add warning while creating site 31df533
    • feat: make landing page responsive 80776dd
    • feat: add hamburger menu in nav aa58397
    • fix: link 12d9b5b
    • refactor: add shtr to showcase 522c5e4
    • docs: add comparison page e16ab54
    • fix: fix responsiveness of docs 137db6f
    • Merge branch 'master' of https://github.com/Lalit2005/hyperdocs 24d2330
    • feat: add analytics 4846987
    • refactor: update readme e75fa2d
    • feat: add links in success page c8323b7
    • feat: seo 35a2939
    • fix: button width 03085b6
    • refactor: add links b73f658
    • fix: link bf826d3
    • fix: link 2dab57d
    • refactor: add tooltip to /themes page 04f5e1a
    • docs: fix code block 2a16f90
    • fix: add revalidate time to all generated pages 5975984
    • docs: fix links 73d7f40
    • fix: add rewrites in next.config.js c2c1281
    • fix: remove _redirects 23eb980
    • docs: add footer docs c8683fa
    • refatcor: create default footer d8e6e42
    • fix: _redirects 5f5e08b
    • feat: add footer support d1dcd4e
    • feat: add showcase 18c11f1
    • docs: typo fix edbf52a
    • cli: add more changes ef47364
    • docs: fix filename 512d7b7
    • refactor: add 2 more sections in homepage 814904c
    • docs: add new homepage page f4219b2
    • feat: autogenerate homepage while creating site 35d258e
    • docs: update feebdack and cli pages e797845
    • fix: empty li in sidebar 6cd9ad6
    • docs: add more pages fc2695d
    • docs: add feedbacks section in vs-docusaurus 16b3849
    • docs: add some important points page 47d3398
    • feat: use replit for bundling mdx 601d389
    • refactor: change a feature 69fc06e
    • docs: add abut blogs and config in vs-docusaurus 0313746
    • docs: add docusarus comparison a23892c
    • refactor: change gradient to new file to avoid full refresh 88dfeb1
    • fix: navbar z-index 4e711e8
    • feat: docs/ route now works without an index.md file too! be297b3
    • feat: docs now generate without _sidebar config 644cc21
    • feat: add playground b23edb8
    • docs: add cli reference page 188bdc5
    • fix: <code> element styling d12405d
    • docs: typo fix 79874dd
    • feat: add CustomComponent 362ad80
    • docs: add components page 42305e6
    • fix: default accordion open state 3bc3498
    • docs: typo fix c229ae9
    • docs: update getting-started to use cli 1f9e1a5
    • docs: fix links and add new how-hyperdocs-works page 839d3ca
    • feat: highlight current page in docs e0653e6
    • feat: add support for _sidebar.txt a4ae889
    • feat: finish landing page 73f08cd

    https://github.com/lalit2005/hyperdocs/compare/v0.0.5...v0.0.6

    Source code(tar.gz)
    Source code(zip)

  • v0.0.5(Feb 27, 2022)

  • v0.0.4(Feb 27, 2022)

  • v0.0.3(Feb 27, 2022)

  • v0.0.2(Feb 27, 2022)

    First release 🎉

    Features

    • Initializing /docs folder with contents
    • Creating new files that updates _sidebar.txt too

    https://github.com/lalit2005/hyperdocs/compare/90df3194caaaffd3b0d410c0e251e6bc50685305...v0.0.2

    Source code(tar.gz)
    Source code(zip)
Owner
Lalit
16. A full stack web developer who loves Jamstack - Next.js, TailwindCSS, prisma and other serverless stuff
Lalit
GitHub https://hyperdocs.netlify.app
Easiest 1-click way to install and use Stable Diffusion on your own computer. Provides a browser UI for generating images from text prompts and images. Just enter your text prompt, and see the generated image.

Stable Diffusion UI Easiest way to install and use Stable Diffusion on your own computer. No dependencies or technical knowledge required. 1-click ins

null 3.5k Dec 30, 2022
Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

Svante Jonsson IT-Högskolan 3 May 18, 2022
Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

null 4 May 3, 2022
Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

null 14 Jan 3, 2023
Wonka JS is the easiest way to mint Metaplex's Candy Machine NFTs with APIs.

Wonka JS Wonka JS is the easiest way to mint from Candy Machine and fetch NFTs through JS APIs. You can see an end to end example in Next.js demo proj

Wonka Labs 71 Nov 3, 2022
🎊 The easiest way to use MineAPI.

@mineapi/sdk Do you need my help? Visit our Discord server. Node Version: 16.16.0 Installation npm i @mineapi/sdk --save # or yarn add @mineapi/sdk Us

MineAPI 5 Jul 29, 2022
The Easiest Way To Write Twitter Threads 🐦

Twotion | The Easiest Way To Write Twitter Threads Write Twitter threads and post them in one click without leaving Notion. Completely Free No Need To

Osada Vidath Chandrasekara 9 Nov 24, 2022
The easiest way to record audio on the web :speaker:

BoothJS (or booth.js) is a zero-dependency, extensible wrapper around the Web Audio API that makes recording audio on the web super easy. Booth fully

Tyler Nickerson 7 Dec 15, 2022
A build plugin to integrate Gatsby seamlessly with Netlify

Essential Gatsby Plugin This build plugin is a utility for supporting Gatsby on Netlify. To support build caching and Gatsby functions on Netlify, you

Netlify 72 Dec 27, 2022
Netlify functions session cookie 🍪

netlify-functions-session-cookie ?? Cryptographically-signed session cookies for Netlify functions. Summary Install Concept and Usage API Environment

Matteo Cargnelutti 7 Jun 8, 2022
testing out ember + netlify's forms

survey-netlify I'm trying Ember + Netlify Forms. Will it work? Let's find out. Steps so far added prember and ember-cli-fastboot used the version of f

Melanie Sumner 3 Feb 14, 2022
A demo to show how to re-use Eleventy Image’s disk cache across Netlify builds.

Re-use Eleventy Image Disk Cache across Netlify Builds Live Demo This repository takes all of the high resolution browser logos and processes them thr

Eleventy 9 Apr 5, 2022
A peculiar little website that uses Eleventy + Netlify + Puppeteer to create generative poster designs

Garden — Generative Jamstack Posters "Garden" is an experiment in building creative, joyful online experiences using core web technologies. ?? Buildin

George Francis 13 Jun 13, 2022
A minimal e-commerce store using Gatsby, SANITY, Stripe, Use-Shopping-Cart and Netlify

?? Gatsby Starter Stripemart Like a supermarket but for Stripe. No ongoing monthly costs. Perfect for artists, creators and independent builders doing

Eric Howey 26 Nov 14, 2022
This is a demo of updating a map to show air quality data for the user’s current location using Next.js Advanced Middleware, powered by Netlify Edge Functions.

Show Local Air Quality Based on the User's Location Use AQI data to show the air quality near the current user. This is built using Next.js Advanced M

Jason Lengstorf 8 Nov 4, 2022
🤖 Persist the Playwright executable between Netlify builds

?? Netlify Plugin Playwright Cache Persist the Playwright executables between Netlify builds. Why netlify-plugin-playwright-cache When you install pla

Hung Viet Nguyen 14 Oct 24, 2022
Get an isolated preview database for every Netlify Preview Deployment

Netlify Preview Database Plugin Create an isolated preview database for each preview deployment in Netlify Quickstart • Website • Docs • Discord • Twi

Snaplet 10 Nov 16, 2022
MySQL meets Jupyter notebooks. Grasp provides a new way to learn and write SQL, by providing a coding-notebook style with runnable blocks, markdown documentation, and shareable notebooks. ✨

A New Way to Write & Learn SQL Report Bug · Request Feature Table of Contents About The Project Built With Getting Started Prerequisites Installation

Lakshya 7 Sep 1, 2022
Catalogist is the easy way to catalog and make your software and (micro)services visible to your organization in a lightweight and developer-friendly way.

catalogist ?? ?? ?? ?? ?? The easy way to catalog and make your software and (micro)services visible to your organization through an API You were a pe

Mikael Vesavuori 11 Dec 13, 2022