Monday, January 2, 2023

Help Compiler

Aaron Trickey:

I just open-sourced my Help Compiler, a self-contained command-line tool to build HTML help from simple plain-text source.


A Mac app’s user guide will frequently reference its main menu. HC has built-in syntax to look up a menu item by its action selector from a NIB file, validating it and extracting the correct menu path. This makes sure the HTML stays updated as when the menu tree changes.


Cross-linking is very simple. Every section gets an ID, which HC ensures is unique, and links reference those IDs, which HC validates and for which it generates the correct relative URL.


Despite all that, most of your text looks like Markdown. Check out the README for full documentation on syntax.


Comments RSS · Twitter · Mastodon

Leave a Comment