Essential guide to mastering the documentation process for Gaffer. This article outlines step-by-step instructions on building and managing the latest Gaffer documentation using MkDocs and the Material theme.
Dive in to learn how to efficiently create, serve, and maintain your project’s documentation with ease.
This repository contains all the documentation for Gaffer, which is published here.
For instructions for building Gaffer’s v1 documentation, see the v1docs branch. The current Gaffer docs are built using MkDocs with the Material theme.
We use Mike for documentation versioning. Running mike is handled by GitHub Actions, so it isn’t something most contributors will need to use unless you make changes to that part of the project.
You need Python (version 3.8 or newer) installed to use MkDocs.
You need MkDocs and the Material theme to generate the documentation. The versions we are using can be installed from the requirements.txt:
pip install -r requirements.txt To generate static documentation files and place them into the default site directory:
mkdocs build Docs can be build and served locally (on localhost:8000) by using:
mkdocs serve This automatically updates and refreshes when local changes are made. Although it might take a few seconds due to the amount of content.
Learning Without Walls Remote education has long been a lifeline for students in rural areas…
Have you ever come across a picture on the internet and wondered where it came…
Overview WhatsMyName is a free, community-driven OSINT tool designed to identify where a username exists…
Managing disk usage is a crucial task for Linux users and administrators alike. Understanding which…
Efficient disk space management is vital in Linux, especially for system administrators who manage servers…
Knowing how to check directory sizes in Linux is essential for managing disk space and…