- 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 🚀
https://github.com/fwd/docs/generate
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.
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 [email protected]:NAME/REPO.git
git push -u origin "master"- Github repo must be public
- Go to Settings Page
- Source → "Master" → "/Root"
- Save
Your public URL: https://NAME.github.io/REPO
- Go to Settings Page
- "Custom domain" → "Add Domain"
- Save
- 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
You now have free, reliable hosting for your docs. Nice.
To keep Docs private, serve /index.html on your own server. Bring your own Auth.
- Github Pages allows Redirect by creating a 404.html file.
- Run
npm buildto do this automatically
cp index.html 404.html
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
Give a ⭐️ if this project helped you!
Contributions, issues and feature requests are welcome at issues page.
MIT License
Copyright © @nano2dev.
