Lib.rs

Catppuccin for mdBook

预览

🌻 拿铁

🪴 摩卡

🌺 卡布奇诺

🌿 咖啡

使用方法

1. 使用以下方法之一安装二进制文件。

   安装方法	说明
   Rust	cargo安装 mdbook-catppuccin
   Homebrew	brew安装 catppuccin/tap/mdbook-catppuccin
   Nix	nix profile install github:catppuccin/mdbook
   GitHub	下载 最新版本
   手动	见下文

2. 导航到您的 mdBook 根目录（与 book.toml 文件相同的目录）并运行 mdbook-catppuccin install

3. 使用 mdbook build 构建，并享受您的新 catppuccin 风味！

手动安装

1. 导航到该仓库中的 src/bin/assets

2. 下载所有资产： index.hbs、catppuccin.css 和 catppuccin-admonish.css

[!注意] 如果您不使用 mdbook-admonish 插件，则不需要 catppuccin-admonish.css 文件。

3. 将下载的资产转移到您的 mdBook 主题目录（默认目录位于 ./theme，在 book.toml 旁边）

4. 按照以下示例更新 additional-css 键

   [output.html]
   -additional-css = []
   +additional-css = ["./theme/catppuccin.css", "./theme/catppuccin-admonish.css"]
   

5. 使用 mdbook build 构建，并享受您的新 catppuccin 风味！

版本兼容性

此表显示了mdBook版本和mdbook-catppuccin版本之间的兼容性。

[!重要]
主要版本的更新可能包含对index.hbs文件的破坏性更改，这意味着您必须手动更新该文件或使用mdbook-catppuccin install --force标志来在安装时覆盖index.hbs。

开发

1. 克隆存储库并导航到存储库根目录。

   git clone https://github.com/catppuccin/mdbook
   cd mdbook
   

2. 运行以下命令以生成将由rust二进制文件打包的CSS文件

   cd palette
   npm install
   npm run build
   

3. 使用以下命令构建rust二进制文件

   注意，最低Rust版本为1.63.0

   cargo build --release
   

4. 通过在example目录中安装新资源来测试二进制文件

   cd example
   ../target/release/mdbook-catppuccin install
   mdbook serve
   

🙋 常见问题解答

• Q: "mdbook-catppuccin二进制文件有什么用?"
  A: 可以说，手动传输文件以避免安装另一个工具会更好。然而，资源将不会被您管理。还有一点值得提的是，该二进制文件将能够检测资源版本之间的差异。

• Q: "catppuccin-admonish.css文件是什么?"
  A: 这是一个CSS文件，用于样式化由mdbook-admonish生成的警告。如果未使用此插件，则可以删除此文件。

  例如：

  [output.html]
  - additional-css = ["./theme/catppuccin.css", "./theme/catppuccin-admonish.css"]
  + additional-css = ["./theme/catppuccin.css"]
  

• Q: "我如何删除默认主题?"
  A: 导航到index.hbs (L154 - L162)并删除您不想要的主题。请记住再次运行mdbook build！

  例如，删除所有默认主题

  - <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
  - <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
  - <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
  - <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
  - <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
  + <li role="none"><button role="menuitem" class="theme" id="latte">Latte</button></li>
  + <li role="none"><button role="menuitem" class="theme" id="frappe">Frappé</button></li>
  + <li role="none"><button role="menuitem" class="theme" id="macchiato">Macchiato</button></li>
  + <li role="none"><button role="menuitem" class="theme" id="mocha">Mocha</button></li>
  

  此外，您还可以使用default-theme和preferred-dark-theme键来设置默认的亮/暗模式主题。

  例如，将默认主题设置为latte并将默认暗模式设置为mocha

  [output.html]
  + default-theme = "latte"
  + preferred-dark-theme = "mocha"
  

致谢

install命令的灵感来自mdbook-admonish，它也是另一个优秀的mdBook预处理器！

💝 感谢

• Hamothy
• winston

版权所有 © 2021-至今 Catppuccin Org