Public documentation site for MARE — a local-first, multi-platform AI reverse-engineering workbench for mobile apps. For authorized security testing and research only.
📖 Live site: https://alvinhayy.github.io/mare-docs/
This repository holds only the documentation (the docs/ tree, authored in GitBook syntax) and
the VitePress build tooling. It is published to GitHub Pages by
.github/workflows/pages.yml on every push to main.
cd tools/vitepress
npm ci
npm run dev # http://localhost:4100 (prebuild runs preprocess.py: docs/ → content)npm run build produces the static site in tools/vitepress/.vitepress/dist.
docs/ is authored in GitBook syntax ({% hint %} blocks, SUMMARY.md
table of contents). tools/vitepress/preprocess.py copies docs/ into a VitePress-friendly
content/ tree (rewriting hint blocks, deriving the sidebar from SUMMARY.md, generating the
landing page + favicon). VitePress then builds content/ into static HTML.
Edit the Markdown under docs/. The table of contents lives in docs/SUMMARY.md.