darkings_Obsidian-MonokaiSyntax/README.zh.md

Monokai Syntax

English README

Monokai Syntax 是一个面向 Obsidian 的 Monokai Pro 风格主题，主要用于代码学习笔记、长期技术写作和日常知识管理。主题重点让阅读模式、Live Preview、文件树、代码块、Callout、关系图谱和 Canvas 保持一致的工作台体验。

版本

当前版本：1.1.1

最低 Obsidian 版本：1.0.0

主要特性

• Monokai Pro 风格深色调色板，以及针对浅色模式调校的 Light 调色板。
• Style Settings 调色板支持 跟随系统、Pro、Light。
• CodeMirror 6 语法高亮映射到 Monokai 风格光谱。
• 阅读模式与 Live Preview 共享语义间距、排版、代码、Callout、块引用、标签、任务、表格和链接变量。
• 文件树图标覆盖常见 Markdown、项目、配置、代码和 Obsidian 专属文件。
• 一级文件夹保留 Obsidian 原生折叠图标；二级及更深层文件夹使用 Monokai 自定义小三角，并避免双图标。
• 代码学习 Callout 覆盖 concept、syntax、api、debug、pitfall、exercise、answer、source、output、terminal。
• 任务状态、API 参数表、行内代码、代码块、Mermaid、Math、Dataview、嵌入、图片、标签、链接和脚注都针对技术笔记做了样式优化。
• 关系图谱、Canvas、Ribbon、标签页、弹窗、搜索、设置和插件界面复用统一主题变量。
• 不加载远程运行时资源，图标字体以内联 WOFF 形式打包。

1.1.1 更新重点

• 修复 Obsidian pending 审核中因 theme.css 包含 Stylelint 控制注释导致的报错。
• 增加 CSS 审计保护，发布产物中出现 Stylelint 控制注释会直接失败。
• 拆分文档：英文主文档为 README.md，中文文档为 README.zh.md。
• 文档中的调色板说明同步为当前实际支持的 跟随系统、Pro、Light。

安装

手动安装

在 Obsidian vault 中创建目录：

你的 Vault/.obsidian/themes/Monokai Syntax/

复制以下文件到该目录：

theme.css
manifest.json

然后在 Obsidian 中进入 设置 -> 外观 -> 主题，选择并启用 Monokai Syntax。

从 GitHub Release 安装

发布 GitHub Release 后，下载对应版本中的：

theme.css
manifest.json

放入你的 vault 主题目录即可。

提交 Obsidian 社区主题

社区主题上架需要向 obsidianmd/obsidian-releases 提交主题信息 PR，并等待审核通过。审核通过后，用户才能在 Obsidian 的社区主题商店中搜索安装。

Style Settings

主题不依赖额外插件也能使用。建议安装 Obsidian 社区插件 Style Settings，以获得完整配置体验。

当前支持：

• 调色板滤镜：跟随系统、Pro、Light。
• 密度模式。
• 彩色或单色文件树图标。
• 文件树图标开关。
• 状态栏右下角同步按钮显示开关。
• 字体与排版选项。
• 标题色条。
• 强调色、链接色与代码色覆盖。

本地开发

安装依赖：

npm install

构建主题：

npm run build

完整验证：

npm run verify

构建并同步到默认 vault：

npm run build:vault

发布前检查：

npm run release:pack

发布流程

1. 确认 package.json、manifest.json、versions.json 版本一致。
2. 运行 npm run release:pack。
3. 确认根目录存在发布产物：

theme.css
manifest.json

4. 创建并推送与 manifest.json 完全一致的版本标签。Obsidian 要求标签不能带 v 前缀：

git tag 1.1.1
git push origin 1.1.1

5. GitHub Actions 会在标签推送后运行发布检查并创建 Release，附件包含 theme.css 与 manifest.json。

验证覆盖

当前发布前验证包含：

• 版本一致性检查。
• 调色板滤镜配置检查。
• 行内代码、编辑模式与阅读模式一致性检查。
• 文件图标生成与图标规则验证。
• 关系图谱变量验证。
• Active 视觉覆盖验证。
• 样式细节检查。
• Node 测试。
• Stylelint。
• WCAG 对比度检查。
• 构建产物一致性检查。
• CSS 审计：禁止远程资源、!important、ID 选择器和 Stylelint 控制注释。

许可证

MIT。详见 LICENSE.md。