Obsidian Minimal Publish 项目启动与配置教程

2025-04-28 10:12:25作者：侯霆垣

1. 项目目录结构及介绍

obsidian-minimal-publish 项目的主要目录结构如下：

obsidian-minimal-publish/
├── .gitignore          # 忽略文件列表
├── assets/             # 静态资源文件夹，存放图片、样式表等
├── config/             # 配置文件文件夹
│   └── _config.yml     # 主配置文件
├── layouts/            # 页面布局文件
│   └── default.njk     # 默认布局文件
├── plugins/            # 插件文件夹
├── src/                # 源代码文件夹
│   ├── css/            # CSS样式文件
│   ├── img/            # 图片资源
│   ├── js/             # JavaScript脚本文件
│   └── index.njk       # 入口页面模板文件
├── test/               # 测试文件夹
└── package.json        # 项目依赖和脚本

主要目录说明：

.gitignore: 指定在Git版本控制中需要忽略的文件和目录。
assets: 存放项目的静态资源，如CSS样式表、JavaScript脚本和图片等。
config: 包含项目的配置文件。
layouts: 页面布局文件，定义了页面的基本结构。
plugins: 存放可能使用的插件。
src: 源代码文件夹，包含了项目的核心代码和资源。
test: 测试文件夹，用于存放测试相关的代码和资源。
package.json: 定义了项目的依赖关系和可执行的脚本。

2. 项目的启动文件介绍

项目的启动主要通过src/index.njk文件进行。这是一个Nunjucks模板文件，它定义了网页的基本结构和内容。在index.njk文件中，通常会包含页面标题、样式表的链接、脚本文件的链接以及页面内容等。

<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
  <title>{{ site.title }}</title>
  <link rel="stylesheet" href="/css/main.css">
</head>
<body>
  <h1>{{ page.title }}</h1>
  <div>{{ page.content }}</div>
  <script src="/js/main.js"></script>
</body>
</html>

在上述代码中，{{ site.title }}、{{ page.title }} 和 {{ page.content }} 是Nunjucks模板的变量，它们在生成页面时会被实际的值所替换。

3. 项目的配置文件介绍

项目的配置主要通过config/_config.yml文件进行。这是一个YAML格式的配置文件，用于定义网站的基本信息、模板设置、元数据等。

以下是一个配置文件的示例：

# 网站元数据
site:
  title: '我的 Obsidian 发布项目'
  description: '一个基于 Obsidian 的静态网站发布项目'
  url: 'https://example.com'

# 模板设置
template:
  layout: default.njk

# 其他配置项
...