A collection of scripts to build offline documentation for your favourite frameworks/libraries/projects. Simply search, copy/paste the commands and enjoy.
Currently 57 projects available
- Backend
- Blockchain
- Build tools
- Cross platform app development
- CSS frameworks/libraries
- Frontend javascript frameworks/libraries
- Javascript testing libraries
- Machine learning
- Programming languages
- Python
- Python web frameworks
- SSG, SSR
- Other
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)
Website - https://expressjs.com
Source code repo - https://github.com/expressjs/expressjs.com
Fast, unopinionated, minimalist web framework for Node.js
git clone --depth=1 https://github.com/expressjs/expressjs.com
cd expressjs.com
# remove hardcoded version for github-pages
sed -i "s|'110', ||g" Gemfile
bundle install
gem install jekyll-redirect-from
bundle exec jekyll build
cd ..
tar czf "expressjs.tar.gz" expressjs.com/_siteLast tested on: 2023-10-30
Website - https://nodejs.org/en/
Source code repo - https://github.com/nodejs/node
Javascript runtime built on Chrome's V8 JavaScript engine
git clone --depth=1 https://github.com/nodejs/node
cd node
./configure
mkdir out/Release
cp `which node` out/Release
make test-doc
cd ..
tar czf "nodejs.tar.gz" node/out/doc/apiLast tested on: 2023-10-30
Requires python and node installed.
Tools, projects, frameworks related to blockchain development
Website - https://ethereum.org/en/
Source code repo - https://github.com/ethereum/ethereum-org-website
Ethereum is a technology that's home to digital money, global payments, and applications.
git clone --depth=1 https://github.com/ethereum/ethereum-org-website
cd ethereum-org-website
yarn install
yarn build:10gb
cd ..
tar czf "ethereum.tar.gz" ethereum-org-website/publicLast tested on: 2023-10-30 (unable to completely build)
ethereum.org is really a very big website and statically building it will require lot of CPU resouces as well as deep node_modules folder.
Website - https://hardhat.org
Source code repo - https://github.com/NomicFoundation/hardhat
Ethereum development environment for professionals.
git clone --depth=1 https://github.com/NomicFoundation/hardhat
cd hardhat
yarn --frozen-lockfile
cd docs/
yarn
yarn add sharp
sed -i 's|images: {|images: {\nloader: "imgix", path:"localhost:8000/",\n|g' hardhat/docs/next.config.js
yarn build
npx next export
cd ..
cd ..
tar czf "hardhat.tar.gz" hardhat/docs/outLast tested on: 2023-11-03
Serve with
npx serve -p 8000. Images only work locally when running on port 8000.
Website - https://maticnetwork.github.io/matic.js/
Source code repo - https://github.com/maticnetwork/matic.js
The @matic.js is a javascript library which helps in interacting with the various components of Matic Network.
git clone --depth=1 -b docs https://github.com/maticnetwork/matic.js
cd matic.js
nvm install 14
nvm use 14
npm ci
npm run deploy
cd ..
tar czf "matic.js.tar.gz" matic.js/buildLast tested on: 2023-11-03
Requires node v14
Website - https://wiki.polygon.technology/
Source code repo - https://github.com/0xPolygon/wiki
The official documentation for 0xPolygon
git clone --depth=1 https://github.com/0xPolygon/wiki
cd wiki
npm install
npm run build
cd ..
tar czf "polygon (matic).tar.gz" wiki/buildLast tested on: 2023-11-03
Use
npm run servefor better experience
Website - https://docs.soliditylang.org/en/v0.8.13/
Source code repo - https://github.com/ethereum/solidity
Solidity is an object-oriented, high-level language for implementing smart contracts. Smart contracts are programs which govern the behaviour of accounts within the Ethereum state.
git clone --depth=1 https://github.com/ethereum/solidity
cd solidity
cd docs
pip install -r requirements.txt
# add timezone environment variable to avoid failing of make
TZ=UTC make html
cd ..
cd ..
tar czf "solidity.tar.gz" solidity/docs/_build/htmlLast tested on: 2023-11-03
Website - https://getwaffle.io
Source code repo - https://github.com/EthWorks/Waffle
The most advanced framework for testing smart contracts. Sweeter, simpler and faster.
git clone --depth=1 https://github.com/EthWorks/Waffle
cd Waffle
cd docs
pip install -r requirements.txt
TZ=UTC make html
cd ..
cd ..
tar czf "waffle.tar.gz" Waffle/docs/dist/htmlLast tested on: 2023-11-03
Website - https://docs.astro.build
Source code repo - https://github.com/withastro/docs
Astro is an all-in-one web framework for building fast, content-focused websites
git clone --depth=1 https://github.com/withastro/docs
cd docs
npx pnpm install --store=node_modules/.pnpm-store
npx pnpm build
cd ..
tar czf "Astro.tar.gz" docs/distLast tested on: 2023-11-03
Website - https://vitejs.dev
Source code repo - https://github.com/vitejs/vite
vite: Next Generation Frontend Tooling
git clone --depth=1 https://github.com/vitejs/vite
cd vite
npm i -g pnpm
npx pnpm i --store=node_modules/.pnpm-store && npm run ci-docs
cd ..
tar czf "vite.tar.gz" vite/docs/.vitepress/distLast tested on: 2023-11-03
Tools useful for development of crossplatform apps
Website - https://www.electronjs.org/
Source code repo - https://github.com/electron/electronjs.org-new
Build cross-platform desktop apps with JavaScript, HTML, and CSS
git clone --depth=1 https://github.com/electron/electronjs.org-new
cd electronjs.org-new
yarn install
yarn build
cd ..
tar czf "Electron.tar.gz" electronjs.org-new/buildLast tested on: 2023-11-03
Website - https://react-native.dev
Source code repo - https://github.com/facebook/react-native-website
Create native apps for Android and iOS using React
git clone --depth=1 https://github.com/facebook/react-native-website
cd react-native-website
yarn install
cd website
yarn build
cd ..
cd ..
tar czf "React Native.tar.gz" react-native-website/website/buildLast tested on: 2023-11-03
Website - https://tauri.studio/
Source code repo - https://github.com/tauri-apps/tauri-docs
Build smaller, faster, and more secure desktop applications with a web frontend
git clone --depth=1 https://github.com/tauri-apps/tauri-docs
cd tauri-docs
yarn install
yarn build
cd ..
tar czf "tauri.tar.gz" tauri-docs/buildLast tested on: 2023-11-03
Website - https://getbootstrap.com/
Source code repo - https://github.com/twbs/bootstrap
The most popular HTML, CSS, and JavaScript framework for developing responsive, mobile first projects on the web.
git clone --depth=1 https://github.com/twbs/bootstrap
cd bootstrap
npm install
npm run docs-build
cd ..
tar czf "bootstrap 5.tar.gz" bootstrap/_siteLast tested on: 2023-11-03
Serve using
python -m http.serverfor best experience.
Website - https://daisyui.com
Source code repo - https://github.com/saadeghi/daisyui
The most popular, free and open-source Tailwind CSS component library
git clone --depth=1 https://github.com/saadeghi/daisyui
cd daisyui
cd src/docs/
npm install
npm run build
cd ../..
cd ..
tar czf "daisyui.tar.gz" daisyui/src/docs/buildLast tested on: 2023-11-03
Website - https://mui.com
Source code repo - https://github.com/mui/material-ui/
MUI offers a comprehensive suite of UI tools to help you ship new features faster.
git clone --depth=1 https://github.com/mui/material-ui/
cd material-ui
yarn
yarn docs:build && yarn docs:export
cd ..
tar czf "material ui.tar.gz" material-ui/docs/exportLast tested on: 2023-11-03
Website - https://maticnetwork.github.io/polygonmesh
Source code repo - https://github.com/maticnetwork/polygonmesh
PolygonMesh is an open-source design system crafted meticulously by the designers and developer at Polygon Technology.
git clone --depth=1 -b docs https://github.com/maticnetwork/polygonmesh
cd polygonmesh
npm ci
npm run build
cd ..
tar czf "polygonmesh.tar.gz" polygonmesh/buildLast tested on: 2023-11-03
Requires node v14
Website - https://storybook.js.org
Source code repo - https://github.com/storybookjs/frontpage
Storybook is an open source tool for building UI components and pages in isolation. It streamlines UI development, testing, and documentation.
git clone --depth=1 https://github.com/storybookjs/frontpage
cd frontpage
yarn install
yarn build:with-prefix
cd ..
tar czf "storybook.tar.gz" frontpage/publicLast tested on: 2022-05-07
Website - https://tailwindcss.com
Source code repo - https://github.com/tailwindlabs/tailwindcss.com
Rapidly build modern websites without ever leaving your HTML. tailwindcss is a utility first CSS framework.
git clone --depth=1 https://github.com/tailwindlabs/tailwindcss.com
cd tailwindcss.com
yarn install
sed -i "s|export default {|export default {\n images: { unoptimized: true},\n|g" next.config.mjs
yarn export
cd ..
tar czf "tailwindcss.tar.gz" tailwindcss.com/outLast tested on: 2023-11-03
Website - https://windicss.org
Source code repo - https://github.com/windicss/docs
Next generation utility-first CSS framework.
git clone --depth=1 https://github.com/windicss/docs
cd docs
npm install pnpm
npx pnpm i --store=node_modules/.pnpm-store
npm run build
cd ..
tar czf "windicss.tar.gz" docs/.vitepress/distLast tested on: 2022-04-19
Website - https://angular.io
Source code repo - https://github.com/angular/angular
The modern web developer's platform for developing single page apps
git clone --depth=1 https://github.com/angular/angular
cd angular
cd aio
yarn install
yarn build
cd ..
cd ..
tar czf "angular.io.tar.gz" angular/aio/distLast tested on: 2022-10-11
Website - https://axios-http.com
Source code repo - https://github.com/axios/axios-docs
Promise based HTTP client for the browser and node.js
git clone --depth=1 https://github.com/axios/axios-docs
cd axios-docs
npm install -g inert-ssg
inert build
cd ..
tar czf "axios.tar.gz" axios-docs/publicLast tested on: 2022-05-21
Website - https://material.angular.io/
Source code repo - https://github.com/angular/material.angular.io
Angular Material is a User Interface (UI) component library that developers can use in their Angular projects to speed up the development of elegant and consistent user interfaces.
git clone --depth=1 https://github.com/angular/material.angular.io
cd material.angular.io
yarn install
yarn build
cd ..
tar czf "Material Angular.tar.gz" material.angular.io/publicLast tested on: 2022-10-11
Make sure you have NodeJS LTS installed
Website - https://react-redux.js.org/
Source code repo - https://github.com/reduxjs/react-redux
Official React bindings for Redux
git clone --depth=1 https://github.com/reduxjs/react-redux
cd react-redux
cd website
npm install
npm run build
cd ..
cd ..
tar czf "react-redux.tar.gz" react-redux/website/buildLast tested on: 2022-04-30
Website - https://reactjs.org
Source code repo - https://github.com/reactjs/reactjs.org
Do you really need an introduction to reactjs?
git clone --depth=1 https://github.com/reactjs/reactjs.org
cd reactjs.org
yarn install
yarn build
cd ..
tar czf "reactjs.tar.gz" reactjs.org/publicLast tested on: 2022-04-15
Website - https://redux.js.org/
Source code repo - https://github.com/reduxjs/redux
Redux is a predictable state container for JavaScript apps.
git clone --depth=1 https://github.com/reduxjs/redux
cd redux
cd website
npm install
npm run build
cd ..
cd ..
tar czf "redux.tar.gz" redux/website/buildLast tested on: 2022-04-29
Website - https://redux-toolkit.js.org/
Source code repo - https://github.com/reduxjs/redux-toolkit
The official, opinionated, batteries-included toolset for efficient Redux development.
git clone --depth=1 https://github.com/reduxjs/redux-toolkit
cd redux-toolkit
cd website
npm install
npm run build
cd ..
cd ..
tar czf "redux toolkit.tar.gz" redux-toolkit/website/buildLast tested on: 2022-04-30
Website - https://rxjs.dev
Source code repo - https://github.com/ReactiveX/rxjs
Reactive Extensions Library for Javascript
git clone --depth=1 https://github.com/ReactiveX/rxjs
cd rxjs
cd docs_app
yarn install
npm run ~~clean-generated && npm run docs && npm run ~~build
cd ..
cd ..
tar czf "RxJS.tar.gz" rxjs/docs_app/distLast tested on: 2022-09-15
Website - https://v3.vuejs.org
Source code repo - https://github.com/vuejs/docs
The Progressive JavaScript Framework. An approachable, performant and versatile framework for building web user interfaces.
git clone --depth=1 https://github.com/vuejs/docs
cd docs
npm i -g pnpm
npx pnpm i --store=node_modules/.pnpm-store && npm run ci-docs
cd ..
tar czf "vuejs V3.tar.gz" docs/.vitepress/distLast tested on: 2022-04-15
Website - https://www.chaijs.com/
Source code repo - https://github.com/chaijs/chaijs.github.io
Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework.
git clone --depth=1 https://github.com/chaijs/chaijs.github.io
cd chaijs.github.io
npm install
gem install bundler:1.16.1
bundle --update bundler
bundle install
make generated_data
bundle exec jekyll build
cd ..
tar czf "chaijs.tar.gz" chaijs.github.io/_siteLast tested on: 2022-04-15
Website - https://jestjs.io
Source code repo - https://github.com/facebook/jest
Jest is delightful Javascript Testing Framework with a focus on simplicity
git clone --depth=1 https://github.com/facebook/jest
cd jest
cd website
yarn install
yarn netlify:prepare && yarn write-translations && yarn build
cd ..
cd ..
tar czf "jest.tar.gz" jest/website/buildLast tested on: 2022-10-15
By default the script builds the website for various languages. To generate only for interested languages (to improve build times), you can modify i18n.js file in website folder.
Website - https://mochajs.org
Source code repo - https://github.com/mochajs/mocha
Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun.
git clone --depth=1 https://github.com/mochajs/mocha
cd mocha
npm install
npm run start docs.production
cd ..
tar czf "mochajs.tar.gz" mocha/docs/_siteLast tested on: 2022-04-15
Website - https://playwright.dev/
Source code repo - https://github.com/microsoft/playwright.dev
Reliable end-to-end testing for modern web apps
git clone --depth=1 https://github.com/microsoft/playwright.dev
cd playwright.dev
npm install
npm run build
cd ..
tar czf "playwright.dev.tar.gz" playwright.dev/buildLast tested on: 2022-07-03
Useful libraries for learning Machine Learning
Website - https://keras.io
Source code repo - https://github.com/keras-team/keras-io
Simple. Flexible. Powerful. Deep learning for humans.
git clone --depth=1 https://github.com/keras-team/keras-io
cd keras-io
pip install -r requirements.txt
cd scripts
python autogen.py make
cd ..
cd ..
tar czf "keras.tar.gz" keras-io/siteLast tested on: 2022-05-23
Website - https://numpy.org/
Source code repo - https://github.com/numpy/numpy
The fundamental package for scientific computing with Python
git clone --depth=1 https://github.com/numpy/numpy
cd numpy
pip install -r doc_requirements.txt
cd doc/
make html
# it will throw an error saying installed version is not matching and will also show command as follows
GITVER=abcdef make html ...
cd ..
tar czf "numpy.tar.gz" numpy/doc/build/html- NumPy Reference Guide - latest PDF
- NumPy User Guide - HTML ZIP
- NumPy User Guide - latest PDF
- Old versions (HTML + ZIP, reference pdf, user pdf)
Last tested on: 2022-05-09
Website - https://numpy.org/numpy-tutorials/
Source code repo - https://github.com/numpy/numpy-tutorials
Set of tutorials and educational materials to learn numpy
git clone --depth=1 https://github.com/numpy/numpy-tutorials
cd numpy-tutorials
cd site
pip install -r requirements.txt
make html
cd ..
cd ..
tar czf "numpy-tutorials.tar.gz" numpy-tutorials/site/_buildLast tested on: 2022-05-10
numpy-tutorials uses jupyter notebooks to generate content, and therefore some examples may be broken due to missing libraries (for ex. ffmpeg)
Website - https://pandas.pydata.org
Source code repo - https://github.com/pandas-dev/pandas
pandas is a fast, powerful, flexible and easy to use open source data analysis and manipulation tool, built on top of the Python programming language
git clone --depth=1 https://github.com/pandas-dev/pandas
cd pandas
cd ..
tar czf "pandas.tar.gz" ./Last tested on: 2022-05-24
pandas uploads the contents of the website as artifacts of docbuild-and-upload workflow. Setting up conda environment and running all those commands is honestly an overkill. Just go to the workflow page, pick a latest successful workflow run and download the artifact. Serve using
python -m http.serverfor best results
Website - https://scipy-cookbook.readthedocs.io
Source code repo - https://github.com/scipy/scipy-cookbook
Collection of various uses-contributed recipes to learn scipy
git clone --depth=1 https://github.com/scipy/scipy-cookbook
cd scipy-cookbook
pip install -r requirements.txt
python build.py --html
cd ..
tar czf "scipy cookbook.tar.gz" scipy.org/publicLast tested on: 2022-05-18
The latest HTML builds are failing, clone the repository and explore the jupyter notebooks for a better experience
Website - https://scipy.github.io/devdocs
Source code repo - https://github.com/scipy/devdocs
SciPy documentation
git clone --depth=1 https://github.com/scipy/devdocs
cd devdocs
# the repository is automatically updated with latest docs
cd ..
tar czf "scipy devdocs.tar.gz" devdocs/Last tested on: 2022-05-18
Works well when served using
python -m http.server
Website - https://scipy.org/
Source code repo - https://github.com/scipy/scipy.org
Fundamental algorithms for scientific computing in Python
git clone --depth=1 https://github.com/scipy/scipy.org
cd scipy.org
pip install -r requirements.txt
brew install hugo
make html
cd ..
tar czf "scipy.org website.tar.gz" scipy.org/publicLast tested on: 2022-05-18
Requires hugo to be installed, follow instructions as per your operating system
Official & useful resources to start learning a new programming language
Website - https://gobyexample.com
Source code repo - https://github.com/mmcgrana/gobyexample
A hands-on introduction to Go using annotated example programs
git clone --depth=1 https://github.com/mmcgrana/gobyexample
cd gobyexample
tools/build
cd ..
tar czf "gobyexample.tar.gz" gobyexample/publicLast tested on: 2022-09-16
Some pages are broken because of missing .html extension. So, run with
npx serveand add .html extention when necessary. For best results run using the go server code given in tools/serve.go file in the repository.
All python related libraries
Website - https://pydantic-docs.helpmanual.io/
Source code repo - https://github.com/samuelcolvin/pydantic
pydantic enforces type hints at runtime, and provides user friendly errors when data is invalid.
git clone --depth=1 https://github.com/samuelcolvin/pydantic
cd pydantic
make install-docs
# Run the following line in case of errors with 'make docs'
echo "def exec_examples(): return 0" > docs/build/exec_examples.py
make docs
cd ..
tar czf "pydantic.tar.gz" pydantic/siteLast tested on: 2022-04-23
Website - https://requests.readthedocs.io/en/latest/
Source code repo - https://github.com/psf/requests
Requests is an elegant and simple HTTP library for Python, built for human beings.
git clone --depth=1 https://github.com/psf/requests
cd requests
cd docs
pip install -r requirements.txt
make html
cd ..
cd ..
tar czf "requests.tar.gz" requests/docs/_build/htmlLast tested on: 2022-06-23
Website - https://www.sqlalchemy.org/
Source code repo - https://github.com/sqlalchemy/sqlalchemy
SQLAlchemy is the Python SQL toolkit and Object Relational Mapper that gives application developers the full power and flexibility of SQL.
git clone --depth=1 https://github.com/sqlalchemy/sqlalchemy
cd sqlalchemy
cd doc/build
pip install -r requirements.txt
make html
cd ../..
cd ..
tar czf "sqlalchemy.tar.gz" doc/build/output/htmlLast tested on: 2022-05-28
Website - https://typer.tiangolo.com/
Source code repo - https://github.com/tiangolo/typer
Typer is a library for building CLI applications that users will love using and developers will love creating. Based on Python 3.6+ type hints.
git clone --depth=1 https://github.com/tiangolo/typer
cd typer
pip install flit
flit install --user --extras doc
sh scripts/build-docs.sh
cd ..
tar czf "typer.tar.gz" typer/siteLast tested on: 2022-04-23
Web frameworks for python
Website - https://bottlepy.org/docs/dev/
Source code repo - https://github.com/bottlepy/bottle
Bottle is a fast, simple and lightweight WSGI micro web-framework for Python. It is distributed as a single file module and has no dependencies other than the Python Standard Library.
git clone --depth=1 https://github.com/bottlepy/bottle
cd bottle
make docs
cd ..
tar czf "bottle.tar.gz" bottle/build/docs/htmlLast tested on: 2022-05-25
Website - https://www.djangoproject.com/
Source code repo - https://github.com/django/django
The web framework for perfectionists with deadlines. Django makes it easier to build better web apps more quickly and with less code.
git clone --depth=1 https://github.com/django/django
cd django
cd docs
pip install -r requirements.txt
make html
cd ..
cd ..
tar czf "django.tar.gz" django/docs/_build/htmlLast tested on: 2022-05-25
Website - https://fastapi.tiangolo.com/
Source code repo - https://github.com/tiangolo/fastapi
FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
git clone --depth=1 https://github.com/tiangolo/fastapi
cd fastapi
pip install flit
flit install --user --extras doc
sh scripts/build-docs.sh
cd ..
tar czf "fastapi.tar.gz" fastapi/siteLast tested on: 2022-04-23
Website - https://flask.palletsprojects.com/en/2.1.x/
Source code repo - https://github.com/pallets/flask
Flask is a lightweight WSGI web application framework. It is designed to make getting started quick and easy, with the ability to scale up to complex applications.
git clone --depth=1 https://github.com/pallets/flask
cd flask
pip install -e .
pip install -r requirements/docs.txt
cd docs
make html
cd ..
cd ..
tar czf "flask.tar.gz" flask/docs/_build/htmlLast tested on: 2022-05-25
Frameworks like nextjs, nuxtjs used for generating static sites
Website - https://docusaurus.io
Source code repo - https://github.com/facebook/docusaurus
Build optimized websites quickly, focus on your content
git clone --depth=1 https://github.com/facebook/docusaurus
cd docusaurus
yarn install
yarn build:packages && yarn build:website:fast
cd ..
tar czf "Docusaurus.tar.gz" docusaurus/website/buildLast tested on: 2022-10-15
You can use
yarn build:websiteif you want to generate static content for all supported languages.
Website - https://nuxtjs.org
Source code repo - https://github.com/nuxt/nuxtjs.org
The Intuitive Vue Framework. Build your next Vue.js application with confidence using Nuxt. An open source framework making web development simple and powerful.
git clone --depth=1 https://github.com/nuxt/nuxtjs.org
cd nuxtjs.org
yarn install
yarn build
cd ..
tar czf "Nuxtjs.tar.gz" nuxtjs.org/distLast tested on: 2022-04-29
Due to the file name restrictions on windows, the build may not work properly with client side hydration. Disable the javascript for best experience.
Website - https://v3.nuxtjs.org
Source code repo - https://github.com/nuxt/framework
The Intuitive Vue Framework. Build your next Vue.js application with confidence using Nuxt. An open source framework making web development simple and powerful.
git clone --depth=1 https://github.com/nuxt/framework
cd framework
cd docs
yarn install
yarn build:ci
cd ..
cd ..
tar czf "Nuxtjs V3.tar.gz" framework/docs/distLast tested on: 2022-04-29
Due to the file name restrictions on windows, the build may not work properly with client side hydration. Disable the javascript for best experience.
Website - https://vitepress.vuejs.org/
Source code repo - https://github.com/vuejs/vitepress
Vite & Vue Powered Static Site Generator
git clone --depth=1 https://github.com/vuejs/vitepress
cd vitepress
npm install
npm run docs-build
cd ..
tar czf "vitepress.tar.gz" vitepress/docs/.vitepress/distLast tested on: 2022-06-06
All other uncategorized tools
Website - https://eslint.org
Source code repo - https://github.com/eslint/website
Find and fix problems in your JavaScript code
git clone --depth=1 https://github.com/eslint/website
cd website
npm install
npm run build
cd ..
tar czf "eslint.tar.gz" website/_siteLast tested on: 2022-04-15
Website - https://developer.mozilla.org
Source code repo - https://github.com/mdn/content
Resources for Developers, by developers
git clone --depth=1 https://github.com/mdn/content
cd content
yarn install
yarn build
cp -r node_modules/@mdn/yari/client/build/ .
cd ..
tar czf "Mozilla Developer Network.tar.gz" content/buildLast tested on: 2022-09-17
MDN is a huge website with more than 11,000 pages. So, instead of building all pages, you may selectively delete unnecessary categories under
files/en-usfolder. Even though you have all HTML pages in build directory, all files are in lowercase whereas links contains camelcase. So, tools such aspython -m http.serverandnpx servemay not be suitable to serve these HTML pages. Instead a simple and working approach is to open the html pages directly in the browser.
Website - https://prettier.io
Source code repo - https://github.com/prettier/prettier
Opinionated code formatter
git clone --depth=1 https://github.com/prettier/prettier
cd prettier
yarn install
yarn build:website
cd ..
tar czf "prettier.tar.gz" prettier/website/buildLast tested on: 2022-04-23
Website - https://www.typescriptlang.org/
Source code repo - https://github.com/microsoft/TypeScript-Website
TypeScript is JavaScript with syntax for types.
git clone --depth=1 https://github.com/microsoft/TypeScript-Website
cd TypeScript-Website
yarn install
yarn bootstrap
yarn build-site
cd ..
tar czf "typescript.tar.gz" TypeScript-Website/docs/buildLast tested on: 2022-04-23
Requires node >=13 and node < 15 for building
- 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.