axomdbook's Introduction

axomdbook

Customized mdbook theme for axo.dev projects (WIP)

Based on 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, 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

[output.html]
default-theme = "axo"
preferred-dark-theme = "axo"

axomdbook's People

Contributors

Watchers

axomdbook's Issues

book title in the header should probably be axo-orange

That's the style our blog uses, but currently it's just axo-pink since we set all headings to that.

I didn't bother because probably that should be set in chrome.css, and so I'd have to un-delete that file to start overriding it?

themeing harmony todo-list

Here's things I didn't bother themeing/harmonizing when i quickly hacked this up, and ostensibly should get a proper pass (fine if the answer is "what we have now is fine", should still validate that):

axo-light theme is based on nothing

I couldn't immediately find our light theme so I just used the mdbook light theme and made some stuff pink and orange in a way that I don't think has good contrast. We should dig up the proper definition.

Recommend Projects