Usage

This page is a practical tour of Pharox: where to get it, which commands exist, and which files you usually touch when you theme or ship your docs site.

Download

Go to Download, pick Windows, Linux, or source. It's recommended to move pharox to a folder that is included in $PATH

Linux

wget https://api.pharox.dev/download/latest/linux
sudo install pharox /usr/local/bin/

Windows

For windows it is recommended to use the installer OR extend the PATH variable by adding the path of your pharox.exe with powershell setx PATH "$env:PATH;C:\path\to\pharox.exe"

Demonstration

Parameter

pharox               # generates the documentation
pharox init          # a TUI installs dependencies and creates config.json
pharox prompt        # creates config.json interactively
pharox scaffold      # writes default template and asset files
pharox plugin        # activate / deactivate plugins, updates config.json
pharox config srcDir=./src headerDir=./include outputDirHTML=./html

Customization

pharox init and pharox scaffold will generate files that will be used by pharox in order to generate the documentation (naming and paths can be set in config.json, defaults are shown below).

`layout.html`

HTML structure of each page. Pharox injects the navbar, page body, title, linked CSS and JS, and other fragments into placeholders such as %PAGE%, %NAVBAR%, %TITLE%, %META%, %LOGO%, %PROJECT%, and %TAGLINE%. Change this file when you want a different HTML structure, header layout, etc.

`meta.html`

this HTML file is directly injected into the <head> for SEO and sharing by using the %META% variable in layout.html (see above). It also contains placeholders like %DESCRIPTION%, %KEYWORDS%, %AUTHOR%, %URL%, Open Graph fields, and Twitter card tags. Edit this when you care about search engine optimization, social previews, or extra <meta> and <link> tags.

`custom.css`

Additional CSS merged into the output (on top of the default stylesheet). Use it for small overrides: spacing, fonts, code block look, dark mode tweaks, and anything you do not want to fork in the primary style.css file.

`inline.js`

Optional JavaScript body inlined into pages. Use it for light UI behavior (theme toggle hooks, small navigation helpers) without maintaining a separate bundled script, unless you prefer the linked script.js path from config instead.

`manifest.json`

Web app manifest for installable or home-screen style hints (name, icons, colors). scaffold creates a starter file in the project root when it is missing. Point your meta or layout at it if you expose icons and want PWA-style metadata.

`config.json`

Single source of truth for directories, output folders, domain and base URL, plugin ids, and paths to every template file above. When you are unsure what a field does or what the defaults are, read the dedicated Configuration page: it lists each key, its default, and how it affects the build.

Actions

Filters