Pharox
©2026 Systemi Co. Ltd.

Configuration

Values in config.json override the built-in defaults below. If plugins is missing or not an array, it is normalized to [].

Field Default Description
srcDir ./src Source directory scanned with headers.
headerDir ./include Primary header directory for API extraction.
filesExt ["*.hpp","*.cpp"] Glob patterns for files to include.
exclude ["template.hpp"] Basenames to skip.
recursive true Recurse into subdirectories when scanning.
outputDirMD ./md Generated Markdown output (classes, navbar, etc.).
outputDirHTML ./html Generated HTML site root.
outputDirExtra ./extra Path to hand-written Markdown pages (each becomes own html).
project Pharox Name shown in titles and chrome.
version 1.0 Version string for metadata.
tagline ©2026 Systemi Co. Ltd. Short line under the project name.
author Yamada Tarou Author / maintainer for meta tags.
brand Systemi Co. Ltd. Brand or company for Open Graph.
description "" Default meta description.
keywords [] Extra SEO keywords (combined with page context).
domain https://pharox.com Canonical / sitemap base URL.
path "" Path segment after domain (e.g. /docs); empty for site root.
servePath . Used when generating internal link paths in some contexts.
base / Base for linking CSS, JS, and logo from generated HTML.
ogImage "" Open Graph image URL.
ogImageAlt Pharox Capsule Cover OG image alt text.
logo ./logo.svg Header logo path.
layout ./layout.html Page shell template (%PAGE%, %NAVBAR%, ... ).
navbar null Overwrite default navbar with your own markdown.
meta ./meta.html Head template for SEO placeholders.
style ./style.css Linked stylesheet path.
script ./script.js Linked script path.
inlineJs ./inline.js Inline script body injected into pages.
customCss ./custom.css CSS merged into the page.
favicon ./favicon.svg Favicon path for meta.
plugins [] Enabled plugin ids (see Plugins).