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.
Introduction to the Model Context Protocol (MCP) The Model Context Protocol (MCP) is an open…
While file extensions in Linux are optional and often misleading, the file command helps decode what a…
The touch command is one of the quickest ways to create new empty files or update timestamps…
Handling large numbers of files is routine for Linux users, and that’s where the find command shines.…
Managing files and directories is foundational for Linux workflows, and the mv (“move”) command makes it easy…
Creating directories is one of the earliest skills you'll use on a Linux system. The mkdir (make…