Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/naveennamani/offline-docs

A collection of scripts to build offline documentation for your favourite frameworks/libraries. Simply search, copy/paste the commands and enjoy.
https://github.com/naveennamani/offline-docs

List: offline-docs

awesome awesome-list build-tool documentation-generator documentation-tool hacktoberfest hacktoberfest-accepted hacktoberfest-starter javascript offline-first python ssg static-site-generator

Last synced: 3 months ago
JSON representation

A collection of scripts to build offline documentation for your favourite frameworks/libraries. Simply search, copy/paste the commands and enjoy.

Host: GitHub
URL: https://github.com/naveennamani/offline-docs
Owner: naveennamani
License: gpl-3.0
Created: 2022-04-16T17:24:08.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-11-03T12:14:24.000Z (about 1 year ago)
Last Synced: 2024-05-23T04:07:24.339Z (5 months ago)
Topics: awesome, awesome-list, build-tool, documentation-generator, documentation-tool, hacktoberfest, hacktoberfest-accepted, hacktoberfest-starter, javascript, offline-first, python, ssg, static-site-generator
Language: JavaScript
Homepage: https://naveennamani.github.io/blog/2022/04/introducing-offline-docs
Size: 142 KB
Stars: 92
Watchers: 7
Forks: 19
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

ultimate-awesome - offline-docs - A collection of scripts to build offline documentation for your favourite frameworks/libraries. Simply search, copy/paste the commands and enjoy. (Other Lists / PowerShell Lists)

README

# Offline-docs

A collection of scripts to build offline documentation for your favourite
frameworks/libraries/projects. Simply search, copy/paste the commands and enjoy.

## Available projects

Currently 57 projects available

- [Backend](#backend)
* [expressjs](#expressjs)
* [nodejs](#nodejs)
- [Blockchain](#blockchain)
* [ethereum](#ethereum)
* [hardhat](#hardhat)
* [matic.js](#maticjs)
+ [Direct links](#direct-links)
* [polygon (matic)](#polygon-matic)
* [solidity](#solidity)
+ [Direct links](#direct-links-1)
* [waffle](#waffle)
+ [Direct links](#direct-links-2)
- [Build tools](#build-tools)
* [Astro](#astro)
* [vite](#vite)
- [Cross platform app development](#cross-platform-app-development)
* [Electron](#electron)
* [React Native](#react-native)
* [tauri](#tauri)
- [CSS frameworks/libraries](#css-frameworkslibraries)
* [bootstrap 5](#bootstrap-5)
* [daisyui](#daisyui)
* [material ui](#material-ui)
* [polygonmesh](#polygonmesh)
+ [Direct links](#direct-links-3)
* [storybook](#storybook)
* [tailwindcss](#tailwindcss)
* [windicss](#windicss)
- [Frontend javascript frameworks/libraries](#frontend-javascript-frameworkslibraries)
* [angular.io](#angulario)
* [axios](#axios)
* [Material Angular](#material-angular)
* [react-redux](#react-redux)
* [reactjs](#reactjs)
* [redux](#redux)
* [redux toolkit](#redux-toolkit)
* [RxJS](#rxjs)
* [vuejs V3](#vuejs-v3)
- [Javascript testing libraries](#javascript-testing-libraries)
* [chaijs](#chaijs)
* [jest](#jest)
* [mochajs](#mochajs)
* [playwright.dev](#playwrightdev)
- [Machine learning](#machine-learning)
* [keras](#keras)
* [numpy](#numpy)
+ [Direct links](#direct-links-4)
* [numpy-tutorials](#numpy-tutorials)
* [pandas](#pandas)
+ [Direct links](#direct-links-5)
* [scipy cookbook](#scipy-cookbook)
+ [Direct links](#direct-links-6)
* [scipy devdocs](#scipy-devdocs)
+ [Direct links](#direct-links-7)
* [scipy.org website](#scipyorg-website)
- [Programming languages](#programming-languages)
* [gobyexample](#gobyexample)
- [Python](#python)
* [pydantic](#pydantic)
* [requests](#requests)
+ [Direct links](#direct-links-8)
* [sqlalchemy](#sqlalchemy)
+ [Direct links](#direct-links-9)
* [typer](#typer)
- [Python web frameworks](#python-web-frameworks)
* [bottle](#bottle)
+ [Direct links](#direct-links-10)
* [django](#django)
+ [Direct links](#direct-links-11)
* [fastapi](#fastapi)
* [flask](#flask)
- [SSG, SSR](#ssg-ssr)
* [Docusaurus](#docusaurus)
* [Nuxtjs](#nuxtjs)
* [Nuxtjs V3](#nuxtjs-v3)
* [vitepress](#vitepress)
- [Other](#other)
* [eslint](#eslint)
* [Mozilla Developer Network](#mozilla-developer-network)
* [prettier](#prettier)
* [typescript](#typescript)

## But why? / Motivation

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.

## How to contribute

Please refer to [CONTRIBUTING.md](CONTRIBUTING.md)

## How to complain about faulty scripts

Open an issue with as detailed error messages as possible.

## Disclaimer

> 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.

## How to use this repo

1. Find the framework/library/tool for which you want to build the documentation
(you can search in the [Available Tools](#available-tools) or with
Ctrl+F)
1. Open a new terminal
1. Copy paste the commands shown
1. Open the output dir as mentioned in the last command (or) unarchive the
.tar.gz file in your preferred location and rename the folder
1. Use any static site serving tools like
[serve (npm package)](https://www.npmjs.com/package/serve) or simply
`python -m http.server`. (We recommend using serve package if no tool is
specified by default)

# Backend

## expressjs

Website - https://expressjs.com

Source code repo - https://github.com/expressjs/expressjs.com

Fast, unopinionated, minimalist web framework for Node.js

```sh
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/_site
```

Last tested on: 2023-10-30

## nodejs

Website - https://nodejs.org/en/

Source code repo - https://github.com/nodejs/node

Javascript runtime built on Chrome's V8 JavaScript engine

```sh
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/api
```

Last tested on: 2023-10-30

> Requires python and node installed.

# Blockchain

Tools, projects, frameworks related to blockchain development

## ethereum

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.

```sh
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/public
```

Last 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.

## hardhat

Website - https://hardhat.org

Source code repo - https://github.com/NomicFoundation/hardhat

Ethereum development environment for professionals.

```sh
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/out
```

Last tested on: 2023-11-03

> Serve with `npx serve -p 8000`. Images only work locally when running on port 8000.

## matic.js

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.

```sh
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/build
```

### Direct links

- [Github pages](https://github.com/maticnetwork/matic.js/archive/refs/heads/gh-pages.zip)

Last tested on: 2023-11-03

> Requires node v14

## polygon (matic)

Website - https://wiki.polygon.technology/

Source code repo - https://github.com/0xPolygon/wiki

The official documentation for 0xPolygon

```sh
git clone --depth=1 https://github.com/0xPolygon/wiki
cd wiki
npm install
npm run build
cd ..
tar czf "polygon (matic).tar.gz" wiki/build
```

Last tested on: 2023-11-03

> Use `npm run serve` for better experience

## solidity

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.

```sh
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/html
```

### Direct links

- [Latest EPUB](https://docs.soliditylang.org/_/downloads/en/latest/epub/)
- [Latest HTML Zip](https://docs.soliditylang.org/_/downloads/en/latest/htmlzip/)
- [Latest PDF](https://docs.soliditylang.org/_/downloads/en/latest/pdf/)

Last tested on: 2023-11-03

## waffle

Website - https://getwaffle.io

Source code repo - https://github.com/EthWorks/Waffle

The most advanced framework for testing smart contracts. Sweeter, simpler and faster.

```sh
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/html
```

### Direct links

- [Latest EPUB](https://ethereum-waffle.readthedocs.io/_/downloads/en/latest/epub/)
- [Latest HTML Zip](https://ethereum-waffle.readthedocs.io/_/downloads/en/latest/htmlzip/)
- [Latest PDF](https://ethereum-waffle.readthedocs.io/_/downloads/en/latest/pdf/)

Last tested on: 2023-11-03

# Build tools

## Astro

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

```sh
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/dist
```

Last tested on: 2023-11-03

## vite

Website - https://vitejs.dev

Source code repo - https://github.com/vitejs/vite

vite: Next Generation Frontend Tooling

```sh
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/dist
```

Last tested on: 2023-11-03

# Cross platform app development

Tools useful for development of crossplatform apps

## Electron

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

```sh
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/build
```

Last tested on: 2023-11-03

## React Native

Website - https://react-native.dev

Source code repo - https://github.com/facebook/react-native-website

Create native apps for Android and iOS using React

```sh
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/build
```

Last tested on: 2023-11-03

## tauri

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

```sh
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/build
```

Last tested on: 2023-11-03

# CSS frameworks/libraries

## bootstrap 5

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.

```sh
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/_site
```

Last tested on: 2023-11-03

> Serve using `python -m http.server` for best experience.

## daisyui

Website - https://daisyui.com

Source code repo - https://github.com/saadeghi/daisyui

The most popular, free and open-source Tailwind CSS component library

```sh
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/build
```

Last tested on: 2023-11-03

## material ui

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.

```sh
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/export
```

Last tested on: 2023-11-03

## polygonmesh

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.

```sh
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/build
```

### Direct links

- [Github pages](https://github.com/maticnetwork/polygonmesh/archive/refs/heads/gh-pages.zip)

Last tested on: 2023-11-03

> Requires node v14

## storybook

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.

```sh
git clone --depth=1 https://github.com/storybookjs/frontpage
cd frontpage
yarn install
yarn build:with-prefix
cd ..
tar czf "storybook.tar.gz" frontpage/public
```

Last tested on: 2022-05-07

## tailwindcss

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.

```sh
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/out
```

Last tested on: 2023-11-03

## windicss

Website - https://windicss.org

Source code repo - https://github.com/windicss/docs

Next generation utility-first CSS framework.

```sh
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/dist
```

Last tested on: 2022-04-19

# Frontend javascript frameworks/libraries

## angular.io

Website - https://angular.io

Source code repo - https://github.com/angular/angular

The modern web developer's platform for developing single page apps

```sh
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/dist
```

Last tested on: 2022-10-11

## axios

Website - https://axios-http.com

Source code repo - https://github.com/axios/axios-docs

Promise based HTTP client for the browser and node.js

```sh
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/public
```

Last tested on: 2022-05-21

## Material Angular

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.

```sh
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/public
```

Last tested on: 2022-10-11

> Make sure you have NodeJS LTS installed

## react-redux

Website - https://react-redux.js.org/

Source code repo - https://github.com/reduxjs/react-redux

Official React bindings for Redux

```sh
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/build
```

Last tested on: 2022-04-30

## reactjs

Website - https://reactjs.org

Source code repo - https://github.com/reactjs/reactjs.org

Do you really need an introduction to reactjs?

```sh
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/public
```

Last tested on: 2022-04-15

## redux

Website - https://redux.js.org/

Source code repo - https://github.com/reduxjs/redux

Redux is a predictable state container for JavaScript apps.

```sh
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/build
```

Last tested on: 2022-04-29

## redux toolkit

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.

```sh
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/build
```

Last tested on: 2022-04-30

## RxJS

Website - https://rxjs.dev

Source code repo - https://github.com/ReactiveX/rxjs

Reactive Extensions Library for Javascript

```sh
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/dist
```

Last tested on: 2022-09-15

## vuejs V3

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.

```sh
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/dist
```

Last tested on: 2022-04-15

# Javascript testing libraries

## chaijs

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.

```sh
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/_site
```

Last tested on: 2022-04-15

## jest

Website - https://jestjs.io

Source code repo - https://github.com/facebook/jest

Jest is delightful Javascript Testing Framework with a focus on simplicity

```sh
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/build
```

Last 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.

## mochajs

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.

```sh
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/_site
```

Last tested on: 2022-04-15

## playwright.dev

Website - https://playwright.dev/

Source code repo - https://github.com/microsoft/playwright.dev

Reliable end-to-end testing for modern web apps

```sh
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/build
```

Last tested on: 2022-07-03

# Machine learning

Useful libraries for learning Machine Learning

## keras

Website - https://keras.io

Source code repo - https://github.com/keras-team/keras-io

Simple. Flexible. Powerful. Deep learning for humans.

```sh
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/site
```

Last tested on: 2022-05-23

## numpy

Website - https://numpy.org/

Source code repo - https://github.com/numpy/numpy

The fundamental package for scientific computing with Python

```sh
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
```

### Direct links

- [NumPy Reference Guide - latest PDF](https://numpy.org/doc/stable/numpy-ref.pdf)
- [NumPy User Guide - HTML ZIP](https://numpy.org/doc/stable/numpy-html.zip)
- [NumPy User Guide - latest PDF](https://numpy.org/doc/stable/numpy-user.pdf)
- [Old versions (HTML + ZIP, reference pdf, user pdf)](https://numpy.org/doc/)

Last tested on: 2022-05-09

## numpy-tutorials

Website - https://numpy.org/numpy-tutorials/

Source code repo - https://github.com/numpy/numpy-tutorials

Set of tutorials and educational materials to learn numpy

```sh
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/_build
```

Last 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)

## pandas

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

```sh
git clone --depth=1 https://github.com/pandas-dev/pandas
cd pandas
cd ..
tar czf "pandas.tar.gz" ./
```

### Direct links

- [Latest PDF](https://pandas.pydata.org/docs/pandas.pdf)
- [Workflow artifacts](https://github.com/pandas-dev/pandas/actions/workflows/docbuild-and-upload.yml)
- [pandas cheatsheet](https://pandas.pydata.org/Pandas_Cheat_Sheet.pdf)

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.server` for best results

## scipy cookbook

Website - https://scipy-cookbook.readthedocs.io

Source code repo - https://github.com/scipy/scipy-cookbook

Collection of various uses-contributed recipes to learn scipy

```sh
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/public
```

### Direct links

- [Latest HTML + ZIP](https://scipy-cookbook.readthedocs.io/_/downloads/en/latest/htmlzip/)

Last tested on: 2022-05-18

> The latest HTML builds are failing, clone the repository and explore the jupyter notebooks for a better experience

## scipy devdocs

Website - https://scipy.github.io/devdocs

Source code repo - https://github.com/scipy/devdocs

SciPy documentation

```sh
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/
```

### Direct links

- [SciPy docs (HTML + ZIP)](https://docs.scipy.org/doc/scipy/scipy-html-1.8.0.zip)
- [SciPy docs PDF (v1.8.0)](https://docs.scipy.org/doc/scipy/scipy-ref-1.8.0.pdf)
- [Scipy docs other versions](https://docs.scipy.org/doc/)
- [github pages](https://github.com/scipy/devdocs/archive/refs/heads/gh-pages.zip)

Last tested on: 2022-05-18

> Works well when served using `python -m http.server`

## scipy.org website

Website - https://scipy.org/

Source code repo - https://github.com/scipy/scipy.org

Fundamental algorithms for scientific computing in Python

```sh
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/public
```

Last tested on: 2022-05-18

> Requires hugo to be installed, follow instructions as per your operating system

# Programming languages

Official & useful resources to start learning a new programming language

## gobyexample

Website - https://gobyexample.com

Source code repo - https://github.com/mmcgrana/gobyexample

A hands-on introduction to Go using annotated example programs

```sh
git clone --depth=1 https://github.com/mmcgrana/gobyexample
cd gobyexample
tools/build
cd ..
tar czf "gobyexample.tar.gz" gobyexample/public
```

Last tested on: 2022-09-16

> Some pages are broken because of missing .html extension. So, run with `npx serve` and add .html extention when necessary. For best results run using the go server code given in tools/serve.go file in the repository.

# Python

All python related libraries

## pydantic

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.

```sh
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/site
```

Last tested on: 2022-04-23

## requests

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.

```sh
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/html
```

### Direct links

- [Latest EPUB](https://requests.readthedocs.io/_/downloads/en/latest/epub/)
- [Latest HTML ZIP](https://requests.readthedocs.io/_/downloads/en/latest/htmlzip/)
- [Latest PDF](https://requests.readthedocs.io/_/downloads/en/latest/pdf/)
- [Stable EPUB](https://requests.readthedocs.io/_/downloads/en/stable/epub/)
- [Stable HTML ZIP](https://requests.readthedocs.io/_/downloads/en/stable/htmlzip/)
- [Stable PDF](https://requests.readthedocs.io/_/downloads/en/stable/pdf/)

Last tested on: 2022-06-23

## sqlalchemy

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.

```sh
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/html
```

### Direct links

- [Latest HTML V1.4](https://docs.sqlalchemy.org/20/sqlalchemy_14.zip)
- [Latest HTML V2.0](https://docs.sqlalchemy.org/20/sqlalchemy_20.zip)

Last tested on: 2022-05-28

## typer

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.

```sh
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/site
```

Last tested on: 2022-04-23

# Python web frameworks

Web frameworks for python

## bottle

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.

```sh
git clone --depth=1 https://github.com/bottlepy/bottle
cd bottle
make docs
cd ..
tar czf "bottle.tar.gz" bottle/build/docs/html
```

### Direct links

- [Latest HTML](https://bottlepy.org/docs/dev/bottle-docs.zip)
- [Latest PDF](https://bottlepy.org/docs/dev/bottle-docs.pdf)

Last tested on: 2022-05-25

## django

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.

```sh
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/html
```

### Direct links

- [Latest EPUB](https://django.readthedocs.io/_/downloads/en/latest/epub/)
- [Latest HTML](https://django.readthedocs.io/_/downloads/en/latest/htmlzip/)
- [Latest PDF](https://django.readthedocs.io/_/downloads/en/latest/pdf/)

Last tested on: 2022-05-25

## fastapi

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.

```sh
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/site
```

Last tested on: 2022-04-23

## flask

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.

```sh
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/html
```

Last tested on: 2022-05-25

# SSG, SSR

Frameworks like nextjs, nuxtjs used for generating static sites

## Docusaurus

Website - https://docusaurus.io

Source code repo - https://github.com/facebook/docusaurus

Build optimized websites quickly, focus on your content

```sh
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/build
```

Last tested on: 2022-10-15

> You can use `yarn build:website` if you want to generate static content for all supported languages.

## Nuxtjs

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.

```sh
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/dist
```

Last 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.

## Nuxtjs V3

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.

```sh
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/dist
```

Last 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.

## vitepress

Website - https://vitepress.vuejs.org/

Source code repo - https://github.com/vuejs/vitepress

Vite & Vue Powered Static Site Generator

```sh
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/dist
```

Last tested on: 2022-06-06

# Other

All other uncategorized tools

## eslint

Website - https://eslint.org

Source code repo - https://github.com/eslint/website

Find and fix problems in your JavaScript code

```sh
git clone --depth=1 https://github.com/eslint/website
cd website
npm install
npm run build
cd ..
tar czf "eslint.tar.gz" website/_site
```

Last tested on: 2022-04-15

## Mozilla Developer Network

Website - https://developer.mozilla.org

Source code repo - https://github.com/mdn/content

Resources for Developers, by developers

```sh
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/build
```

Last 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-us` folder. Even though you have all HTML pages in build directory, all files are in lowercase whereas links contains camelcase. So, tools such as `python -m http.server` and `npx serve` may not be suitable to serve these HTML pages. Instead a simple and working approach is to open the html pages directly in the browser.

## prettier

Website - https://prettier.io

Source code repo - https://github.com/prettier/prettier

Opinionated code formatter

```sh
git clone --depth=1 https://github.com/prettier/prettier
cd prettier
yarn install
yarn build:website
cd ..
tar czf "prettier.tar.gz" prettier/website/build
```

Last tested on: 2022-04-23

## typescript

Website - https://www.typescriptlang.org/

Source code repo - https://github.com/microsoft/TypeScript-Website

TypeScript is JavaScript with syntax for types.

```sh
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/build
```

Last tested on: 2022-04-23

> Requires node >=13 and node < 15 for building

---

## Todo

- [ ] Auto update of README.md on push to main

---

Visit my blog for latest articles related to web development
[https://naveennamani.github.io/blog](https://naveennamani.github.io/blog) and
for projects like this.

Follow me on [dev.to/naveennamani](https://dev.to/naveennamani).