Easy Docs

(HTML + JSON + Markdown + Github Pages)

Live Demo

https://docs.nano.to

Features

1 Minute Install
No Compiling or Installing
Write in Markdown
Local & Remote Markdown Files
Host on Github Pages
Edit Docs on Github (If you want)
Changelog & FAQ Section
No Installing or Compiling
Light/Dark Mode
Offline Support
Mobile Optimized
Developer Friendly
Mars Ready 🚀

❯ 1. Easy Install (Github Template)

❯ 2. Edit Files

You can edit files directly on Github. Or clone the repo, edit pages with favorite editor, and serve /index.html with a server to preview changes.

NPM: npm start

PHP: php -S localhost:8080

Edit:

/pages - Pages in Markdown.
config.json - Configure Documentation.
favicon.png - Customize Favicon.
/images - Images for your docs.

Optional:

custom.css - Optional, Custom CSS.
index.html - Most things are configured via JSON file.
/assets - Docs CSS & JS Files.

❯ 3. Deploy

Remove the .git folder, and add your own.

rm -rf .git
git init
git add . && git commit -m "Look Ma! I'm on Github."
git branch -M "master"
git remote add origin git@github.com:NAME/REPO.git
git push -u origin "master"

❯ 4. Enable Github Pages

Github repo must be public
Go to Settings Page
Source → "Master" → "/Root"
Save

Your public URL: https://NAME.github.io/REPO

Optional: Custom Domain:

Go to Settings Page
"Custom domain" → "Add Domain"
Save

Domain DNS Settings

Create A record that points to: 185.199.108.153
If using Cloudflare, make sure to disable proxy.

Official Docs: https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site

❯ ✅ Done

You now have free, reliable hosting for your docs. Nice.

❯ Further Reading

Private Hosting

To keep Docs private, serve /index.html on your own server. Bring your own Auth.

404 & Redirects

Github Pages allows Redirect by creating a 404.html file.
Run npm build to do this automatically

cp index.html 404.html

Updating Docs

More features are planned for Easy Docs. If you don't edit /assets and index.html. You can update at anytime.

npm run update

Planned Features

Translation
Codepen
API Testing

❯ Contributing

Give a ⭐️ if this project helped you!

Contributions, issues and feature requests are welcome at issues page.

❯ License

MIT License

fwd/docs