yelp-tools ☆
« Back to VersTracker
Description:
Tools that help create and edit Mallard or DocBook documentation
Type: Formula  |  Tracked Since: Dec 28, 2025
Links: Homepage  |  @gnome  |  formulae.brew.sh
Category: Developer tools
Tags: documentation gnome mallard docbook authoring
Install: brew install yelp-tools
About:
Yelp Tools is a collection of command-line utilities designed to assist with creating, maintaining, and publishing documentation using the Mallard and DocBook XML formats. It includes scripts for validating document structure, building help collections, and staging content for the Yelp help browser. The suite simplifies the authoring workflow for GNOME application documentation.
Key Features:
  • yelp-build: Compiles Mallard and DocBook pages into HTML or EPUB formats
  • yelp-check: Validates document structure, links, and internationalization settings
  • yelp-new: Scaffolds new Mallard or DocBook pages with proper XML templates
  • Integration with the Yelp help browser for local document viewing
Use Cases:
  • Generating offline help documentation for Linux applications
  • Validating and publishing technical documentation in Mallard format
Alternatives:
  • Sphinx – Python-based system using reStructuredText; more complex but supports multiple output formats
  • Pandoc – Universal document converter; better for format conversion than structured authoring
Version History
Detected Version Rev Change Commit
Nov 13, 2024 10:49am 0 VERSION_BUMP 1b071d7f
Oct 10, 2024 2:30pm 0 VERSION_BUMP 242d1cfa
Sep 28, 2024 10:41pm 0 VERSION_BUMP 325b0caf
« Back to VersTracker  |  Browse Packages  |  About