The BinaryNoir developer hub, live at https://binarynoir.tech.
It documents BinaryNoir's open-source VitePress plugins, Vite plugins and command-line apps, and it is built with every one of those plugins, so it doubles as a working demo of how they fit together.
| Package | Role on this site |
|---|---|
@binarynoir/vitepress-auto-sidebar |
Builds the sidebar from the folder tree |
@binarynoir/vitepress-auto-navbar |
Builds the top navbar from the folder tree |
@binarynoir/vitepress-sidebar-accordion |
One open sidebar group per level, as in VuePress, and a sidebar filter |
@binarynoir/vitepress-markdown-tags |
Status badges and tagged-page lists |
@binarynoir/vitepress-reading-time-tag |
[[readingTime]] tip blocks |
@binarynoir/vitepress-downloads |
Downloadable files from a downloads folder |
markdown-it-glossary |
Hover definitions from docs/reference/glossary.md |
@binarynoir/vitepress-text-style |
[t:red]text[/t] colored and sized text |
@binarynoir/vitepress-html-escape |
Stray tags like Array<string> and {{ }} render as text; hints underline them in docs:dev |
@binarynoir/vitepress-broken-links |
Dead links render as text with a fix-it popover instead of failing the build |
@binarynoir/vitepress-exclude |
.exclude files keep pages out of the build (a draft in docs/plugins/exclude/ on purpose) |
@binarynoir/vitepress-readme-index |
README.md served as a folder's index page, for VuePress migrations |
@binarynoir/vite-plugin-optimize-images |
Re-compresses images in the build output |
@binarynoir/vite-plugin-image-fallback |
Placeholder for missing images (one is missing on purpose) |
Requires Node 22 or newer.
npm install
npm run docs:dev # dev server
npm run docs:build # production build into docs/.vitepress/dist
npm run docs:preview # serve the production build
npm run format:check # prettier, also run in CIPushing to main runs .github/workflows/deploy.yml, which builds the site and publishes it with GitHub Pages. Pull requests run ci.yml, which builds without deploying. See docs/guide/deploying.md for the full setup.
The repository's Pages source must be set to GitHub Actions (Settings → Pages).
docs/plugins/image-fallback.md references an image that does not exist, on purpose, to demonstrate the image-fallback plugin. The build logs a warning for it. That is expected.
Likewise, docs/plugins/broken-links.md links to two pages that do not exist, to demonstrate the broken-links plugin. The build logs a warning for each one, and that is expected too.
Code is MIT licensed. The BinaryNoir name, logos and site content are the property of John Smith III / BinaryNoir and are not covered by that license; see docs/legal.md.