lyric-book

纯笔记 vault。用 Obsidian 打开这个目录,在这里写歌词、编曲笔记、灵感片段。

本仓库不含任何构建产物——它是内容源,不是应用。

用 Obsidian 打开

Obsidian → Open folder as vault → 选本仓库根目录。

首次打开时 Obsidian 会自己生成 .obsidian/。其中与本机绑定的部分 (窗口布局、标签页状态)已在 .gitignore 里排除;插件与主题配置则会正常提交, 这样换台机器打开就能得到同一套环境。

笔记格式

普通 Markdown + YAML frontmatter,Obsidian 与 Quartz 都能直接读:

---
title: 歌名
artist: 歌手
album: 专辑
tags:
  - 歌词
---
 
正文……

templates/ 放 Obsidian 模板,attachments/ 放图片与音频。 templates/ 在 Quartz 默认的 ignorePatterns 里,不会被渲染进站点; attachments/ 不在其列,图片与音频会被复制进产物供歌词引用,但该目录下的 Markdown 也会照常渲染成页面。

本文件名为 INDEX.md 而非 README.md:Quartz 会把 slug 为 index 的文件 当作站点首页渲染,所以改名后本文件就是站点首页。

本仓库以 git submodule 的形式挂在 MusicGallery/music-gallery 的 apps/lyric-book 下。

因此它故意没有 package.json:pnpm workspace 与 turbo 都靠扫描 package.json 识别工作区包,没有它就意味着这个目录不参与任何安装、类型检查、 构建或测试。内容 vault 也不需要——它没有构建步骤。

需要把它渲染成网站时,交给 Quartz(monorepo 里的 apps/quartz), 用 -d 指向本目录,而不是在这里另起一套构建。

在 monorepo 里使用:

# 首次克隆
git clone --recurse-submodules https://github.com/MusicGallery/music-gallery.git
 
# 已经克隆过 monorepo 的,补检出本仓库
git submodule update --init --recursive