mkdocs-walt

🍃 Walt是MkDocs的一个最小化文档主题。

它有以下特性

• 基于writ.css的无类样式，用于语义HTML
• 基于系统设置的浅色模式与深色模式
• 支持svg网站图标的浏览器使用的emoji favicon
• 使用highlight.js进行代码语法高亮显示

安装

pip install mkdocs-walt

使用

使用mkdocs CLI创建一个新的MkDocs项目，并在项目的mkdocs.yml中添加以下内容

theme:
  name: walt

请参阅端到端示例。

默认设置

Walt默认设置以下配置

site_emoji: 🍃
locale: en
theme_color: "hsl(0, 0%, 100%)"
theme_color_dark: "hsl(232, 23%, 18%)"
include_header: true
include_nav: true
highlightjs: true

许可

版权所有 © 2023 Suzen Fylke。在MIT许可下分发。

鸣谢

Walt使用writ.css进行样式，并使用Catppuccin进行代码块语法高亮和深色模式颜色方案。