|
| 1 | +# binarynoir.github.io |
| 2 | + |
| 3 | +The [BinaryNoir](https://github.com/binarynoir) developer hub, live at **https://binarynoir.github.io**. |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +## Plugins demonstrated |
| 8 | + |
| 9 | +| Package | Role on this site | |
| 10 | +| ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- | |
| 11 | +| [`@binarynoir/vitepress-auto-sidebar`](https://github.com/binarynoir/vitepress-auto-sidebar) | Builds the sidebar from the folder tree | |
| 12 | +| [`@binarynoir/vitepress-auto-navbar`](https://github.com/binarynoir/vitepress-auto-navbar) | Builds the top navbar from the folder tree | |
| 13 | +| [`@binarynoir/vitepress-markdown-tags`](https://github.com/binarynoir/vitepress-markdown-tags) | Status badges and tagged-page lists | |
| 14 | +| [`@binarynoir/vitepress-reading-time-tag`](https://github.com/binarynoir/vitepress-reading-time-tag) | `[[readingTime]]` tip blocks | |
| 15 | +| [`markdown-it-glossary`](https://github.com/binarynoir/markdown-it-glossary) | Hover definitions from `docs/reference/glossary.md` | |
| 16 | +| [`@binarynoir/vite-plugin-optimize-images`](https://github.com/binarynoir/vite-plugin-optimize-images) | Re-compresses images in the build output | |
| 17 | +| [`@binarynoir/vite-plugin-image-fallback`](https://github.com/binarynoir/vite-plugin-image-fallback) | Placeholder for missing images (one is missing on purpose) | |
| 18 | + |
| 19 | +## Develop |
| 20 | + |
| 21 | +Requires Node 22 or newer. |
| 22 | + |
| 23 | +```sh |
| 24 | +npm install |
| 25 | +npm run docs:dev # dev server |
| 26 | +npm run docs:build # production build into docs/.vitepress/dist |
| 27 | +npm run docs:preview # serve the production build |
| 28 | +npm run format:check # prettier, also run in CI |
| 29 | +``` |
| 30 | + |
| 31 | +## Deploy |
| 32 | + |
| 33 | +Pushing to `main` runs [`.github/workflows/deploy.yml`](.github/workflows/deploy.yml), which builds the site and publishes it with GitHub Pages. Pull requests run [`ci.yml`](.github/workflows/ci.yml), which builds without deploying. See [docs/guide/deploying.md](docs/guide/deploying.md) for the full setup. |
| 34 | + |
| 35 | +The repository's Pages source must be set to **GitHub Actions** (Settings → Pages). |
| 36 | + |
| 37 | +## A note on the missing image |
| 38 | + |
| 39 | +`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. |
| 40 | + |
| 41 | +## License |
| 42 | + |
| 43 | +[MIT](LICENSE) |
0 commit comments