Repository navigation
Add GitHub Pages documentation site (issue 12) - #17
Merged
Merged
Conversation
- MkDocs + Material theme (mkdocs.yml) with a teal brand palette, mirroring the QuasarApp/Heart documentation setup but using a different visual color scheme - docs/overrides/main.css: teal palette overrides for the light and slate schemes - res/doxygen-material.css: Material restyle of the Doxygen HTML output in the same teal palette - doxygen.conf.in: Doxygen template (API output under docs/api/, call/caller graphs, C-optimized output) - .github/workflows/deploy-docs.yml: build Doxygen + MkDocs on push to main and deploy to the gh-pages branch - .gitignore: ignore the generated documentation artifacts (doxygen.conf, docs/api/, docs/index.md, docs/LICENSE, site/) Note: after the first deploy, GitHub Pages must be configured to serve the gh-pages branch (repository settings, maintainer action). Fixes QuasarApp#12
EndrII
approved these changes
Oct 13, 2026
Closed
Member
Author
|
Status: approved and mergeable, CI green - ready for maintainer merge. |
This was referenced Oct 13, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements the GitHub Pages documentation site (issue #12), by analogy with the QuasarApp/Heart docs setup — same structure (MkDocs + Material + Doxygen under
/api/+gh-pagesdeploy workflow) but a different visual color scheme: teal instead of maroon:mkdocs.yml— Material theme, teal palette (#0e6b64primary /#0d7d70light-scheme accent /#6fd0c2slate-scheme accent), Roboto / Roboto Mono, same feature set as Heart.docs/overrides/main.css— teal palette overrides for the light and slate color schemes.doxygen.conf.in— Doxygen template:@OPENSIMPLEX2_VERSION@=1.0.<commit-count>.<short-sha>, output intodocs/api/, C-optimized extraction, call/caller graphs.res/doxygen-material.css— Material restyle of the Doxygen HTML output in the same teal palette (Doxygen 1.18 CSS-variable based; copied into the output byHTML_EXTRA_STYLESHEET)..github/workflows/deploy-docs.yml— on push tomain(andworkflow_dispatch): installs Doxygen 1.18.0 + Graphviz, generatesdoxygen.conf, builds the Doxygen HTML intodocs/api/, copiesREADME.md->docs/index.md(README stays the single source of truth), installsmkdocs==1.6.1+mkdocs-material==9.7.7, runsmkdocs build --strictand deployssite/to thegh-pagesbranch..gitignore— generated artifacts (doxygen.conf,docs/api/,docs/index.md,docs/LICENSE,site/).Validated locally end-to-end:
doxygen doxygen.conf->docs/api/(9 call graphs),mkdocs build --strictpasses with no warnings, teal palette confirmed in the built site.Maintainer note: after the first deploy, GitHub Pages must be configured in the repository settings to serve the
gh-pagesbranch, path/(the QuasarAppCI account has no Pages admin permission).Fixes #12