Tutorials

Gaffer Doc – A Comprehensive Guide To Building And Managing Documentation

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.

Building The Documentation

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.

Prerequisites

Python

You need Python (version 3.8 or newer) installed to use MkDocs.

MkDocs Dependencies

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

Build The Documentation Site

To generate static documentation files and place them into the default site directory:

mkdocs build

Build And Serve The Documentation Site (Recommended)

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.

Varshini

Varshini is a Cyber Security expert in Threat Analysis, Vulnerability Assessment, and Research. Passionate about staying ahead of emerging Threats and Technologies.

Recent Posts

ROADTools: The Modern Azure AD Exploration Framework

ROADTools is a powerful framework designed for exploring and interacting with Microsoft Azure Active Directory…

13 hours ago

How to Enumerate Microsoft 365 Groups Using PowerShell and Python

Microsoft 365 Groups (also known as M365 Groups or Unified Groups) are at the heart…

13 hours ago

SeamlessPass: Using Kerberos Tickets to Access Microsoft 365

SeamlessPass is a specialized tool designed to leverage on-premises Active Directory Kerberos tickets to obtain…

1 day ago

PPLBlade: Advanced Memory Dumping and Obfuscation Tool

PPLBlade is a powerful Protected Process Dumper designed to capture memory from target processes, hide…

2 days ago

HikPwn : Simple Scanner For Hikvision Devices With Basic Vulnerability Scanning

HikPwn: Comprehensive Guide to Scanning Hikvision Devices for Vulnerabilities If you’re searching for an efficient…

2 days ago

Comments in Bash Scripts

What Are Bash Comments? Comments in Bash scripts, are notes in your code that the…

1 week ago