Typomagical Obsidian 项目使用教程
1. 项目的目录结构及介绍
Typomagical Obsidian 项目的目录结构如下:
typomagical-obsidian/
├── github/
│ └── ISSUE_TEMPLATE/
├── images/
├── src/
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── Typomagical-split.jpg
├── Typomagical.gif
├── Typomagical.jpg
├── decisions.md
├── manifest.json
├── theme.css
└── typomagical-settings.jpg
目录结构介绍
- github/ISSUE_TEMPLATE/: 存放项目的问题模板文件。
- images/: 存放项目的图片资源。
- src/: 存放项目的源代码文件。
- CONTRIBUTING.md: 贡献指南文件,指导开发者如何为项目贡献代码。
- LICENSE: 项目的开源许可证文件,本项目使用 GPL-3.0 许可证。
- README.md: 项目的介绍文件,包含项目的功能、使用方法等信息。
- Typomagical-split.jpg: 项目的图片资源。
- Typomagical.gif: 项目的图片资源。
- Typomagical.jpg: 项目的图片资源。
- decisions.md: 项目决策记录文件,记录项目开发过程中的重要决策。
- manifest.json: 项目的配置文件,定义了项目的元数据。
- theme.css: 项目的主要样式文件,定义了 Obsidian 主题的样式。
- typomagical-settings.jpg: 项目的图片资源。
2. 项目的启动文件介绍
Typomagical Obsidian 项目的主要启动文件是 theme.css
。这个文件定义了 Obsidian 主题的样式,包括字体、颜色、布局等。用户可以通过 Obsidian 的外观设置界面启用这个主题。
启动步骤
- 打开 Obsidian 应用。
- 进入“外观”设置。
- 点击“管理”按钮。
- 在搜索框中输入“Typo”,找到 Typomagical 主题。
- 点击“使用”按钮,启用主题。
3. 项目的配置文件介绍
Typomagical Obsidian 项目的主要配置文件是 manifest.json
。这个文件定义了项目的元数据,包括主题的名称、版本、描述等信息。
manifest.json
文件内容示例
{
"id": "typomagical-obsidian",
"name": "Typomagical",
"version": "2.1.0",
"minAppVersion": "0.11.0",
"description": "An Obsidian theme for typographic appreciators, with support for Style Settings by mgmeyers.",
"author": "hungsu",
"authorUrl": "https://github.com/hungsu",
"isDesktopOnly": false
}
配置文件介绍
- id: 主题的唯一标识符。
- name: 主题的名称。
- version: 主题的版本号。
- minAppVersion: 支持的最小 Obsidian 应用版本。
- description: 主题的描述信息。
- author: 主题的作者。
- authorUrl: 作者的 GitHub 主页链接。
- isDesktopOnly: 是否仅支持桌面版 Obsidian。
通过以上配置文件,Obsidian 应用可以正确识别并加载 Typomagical 主题。