https://github.com/axodotdev/axomdbook
Customized mdbook theme for axo.dev projects
https://github.com/axodotdev/axomdbook
Last synced: 4 months ago
JSON representation
Customized mdbook theme for axo.dev projects
- Host: GitHub
- URL: https://github.com/axodotdev/axomdbook
- Owner: axodotdev
- Created: 2023-05-13T20:24:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-13T20:47:46.000Z (about 3 years ago)
- Last Synced: 2025-02-19T23:16:56.905Z (over 1 year ago)
- Language: JavaScript
- Size: 932 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# axomdbook
Customized [mdbook theme](https://rust-lang.github.io/mdBook/format/theme/index.html) for axo.dev projects (WIP)
Based on [oranda-css](https://github.com/axodotdev/oranda/tree/main/oranda-css), using the base theme of mdbook v0.4.27.
Ideally this will be generated for you by our tools, but for now here's an isolated demo where it can be tested.
The licensing of mdbook [is MPL 2.0](https://github.com/rust-lang/mdBook/blob/master/LICENSE), so presumably the base theme we're modifying is also under that license. Our modifications will probably also be under that license for simplicity, or the usual dual MIT/Apache if that's allowed (gotta double-check how that works...).
# Usage
This adds two non-standard mdbook themes:
* axo (variant of mdbook's "navy")
* axo-light (variant of mdbook's "light")
In principle all you need to do to add this theme to your mdbook is:
* copy the `theme` dir into your mdbook
* (if you want them to be the default) edit your book.toml to include
```toml
[output.html]
default-theme = "axo"
preferred-dark-theme = "axo"
```