Git is a distributed version control system

Prerequisites

Install On macOS

brew update && brew install hugo

# Update ulimit
sudo sysctl -w kern.maxfiles=65536
sudo sysctl -w kern.maxfilesperproc=65536
ulimit -n 65536 65536

# Install rsync 3
brew instal rsync

# Install HTML XML Utils
brew install html-xml-utils

# Parallel
brew install parallel

# Pandoc
brew install pandoc

# Pygments
pip install Pygments

Install On Linux

# Update ulimit
sudo sysctl -w kern.maxfiles=65536
sudo sysctl -w kern.maxfilesperproc=65536
ulimit -n 65536 65536

# Install HTML XML Utils
sudo apt-get install html-xml-utils

# Pygments
sudo apt-get install python3-pygments

Bootstrapping

The bootstrap process synchronizes all of the documentation from kernel.org's source of git documentation, sanitizes the output and then places the data in the websites scafolding.

cd scripts
./bootstrap.sh

Publish

publish.sh publishes the website to GitHub using the gh-pages branch

cd scripts
./publish.sh

Run

Run Locally

hugo server