A collection of scripts to build offline documentation for your favourite frameworks/libraries/projects. Simply search, copy/paste the commands and enjoy.
Learning or working on a new language/framework/library often requires referring to the official docs multiple times. With the rise of Static Site Generation (SSG) many documentation sites are now open-source and can be built for offline usage. This project aims to collect all such projects and the build commands to have a knowledge of widely used SSG tools.
Please refer to CONTRIBUTING.md
Open an issue with as detailed error messages as possible.
All the content generated using the scripts mentioned in this repository are copyright of the owners of the repo from which the documentation is generated. Only use the generated content for personal use. Terms and conditions for sharing/modifying/distributing the generated content will be applicable as per the license terms of the original repo.
- Find the framework/library/tool for which you want to build the documentation (you can search in the Available Tools or with Ctrl+F)
- Open a new terminal
- Copy paste the commands shown
- Open the output dir as mentioned in the last command (or) unarchive the .tar.gz file in your preferred location and rename the folder
- Use any static site serving tools like
serve (npm package) or simply
python -m http.server. (We recommend using serve package if no tool is specified by default)
- Auto update of README.md on push to main
Visit my blog for latest articles related to web development https://naveennamani.github.io/blog and for projects like this.
Follow me on dev.to/naveennamani.