An open API service indexing awesome lists of open source software.

https://github.com/phoenixr-codes/mdbook-nord-theme

Nord Theme for mdBook
https://github.com/phoenixr-codes/mdbook-nord-theme

mdbook mdbook-theme nord-theme

Last synced: 25 days ago
JSON representation

Nord Theme for mdBook

Awesome Lists containing this project

README

          

# Nord Theme for mdBook

**Live Demo**:

## Installation

### Quick Install (*nix)

> [!IMPORTANT]
> You need the `index.hbs` created with `mdbook init --theme`.

In the directory containing `book.toml`, execute

```console
bash <(curl -L https://github.com/phoenixr-codes/mdbook-nord-theme/releases/latest/download/install.sh)
```

### Manual Installation

1. If you haven't already created a book, create one with: `mdbook init --theme` and delete all files in `theme/` except `index.hbs`.
2. Create the `theme/` directory of your mdBook directory if it does not exist already.
3. Copy all CSS files from the `src/` directory of this repository into the `theme/` directory of your mdBook directory.
4. Apply this addition to `book.toml`:
```toml
[output.html]
default-theme = "snow-storm"
preferred-dark-theme = "polar-night"
additional-css = [
"./theme/nord.css",
"./theme/nord-highlight.css",
"./theme/nord-admonish.css",
"./theme/mdbook-admonish.css",
"./theme/nord-alerts.css",
]
```
4. Apply these additions to `index.hbs`:
```diff

  • Light

  • Rust

  • Coal

  • Navy

  • Ayu

  • +
  • Polar Night

  • +
  • Snow Storm

  • ```
    ```diff



    +
    ```

    ---

    Repository layout and infrastructure inspired by .

    ![Polar Night preview](./screenshots/polar-night.png)
    ![Snow Storm preview](./screenshots/snow-storm.png)