nicknamenamenick/bazzite-help

OUTDATED! This repo is a mess and has changed constantly. It serves as my playground for offline documentation for Bazzite.

THIS IS OUTDATED!

However, it still might work if you want to see the original method of offline documentation which was exclusively for GNOME images at the time.

What we're doing now: https://github.com/ublue-os/bazzite/tree/main/docs

bazzite-help

Example linux yelp-based help documentation, using yelp-tools for freedesktop.org compliant linux help.

Mallard is used for documentation markup language.

Instructions

Dev Container

Open this project using the given devcontainer specification

Building

It is recommended to build this in a Distrobox or Toolbx container.

Dependencies:

• make (for building)
• yelp-tools
• yelp

Download this repo and extract the archive to a preferrred location.

cd /path/to/bazzite-help-main/

make

Output file will be index.epub

Reading Help File

From the host:

cd /path/to/bazzite-help-main/docs

yelp .

References Directory

These are translated from the Discourse documentation using html2mallard. Personally, I cherry pick from these reference files.

Cleaning

make clean