配置

网站的所有设置都在一个文件里——仓库根目录(笔记文件夹旁边)的 markdown-publish.config.json。

{
  "siteName": "我的笔记",
  "siteDescription": "笔记与想法",
  "siteLang": "zh",
  "siteUrl": "https://你的用户名.github.io/你的仓库名",
  "siteFooter": "",
  "vaultDir": "vault",
  "buildMode": "full",
  "baseHref": "/",
  "out": "dist"
}

每个键的含义

键	作用	默认值
`siteName`	页头和 `<title>` 里的名称	vault 文件夹的名字
`siteDescription`	给搜索引擎和社交网络看的描述	—
`siteLang`	内容语言(`zh`、`en`……)	`en`
`siteUrl`	网站的完整地址——sitemap 和 OG 卡片需要它	—
`siteFooter`	侧边栏底部的署名(留空则不显示)	—
`vaultDir`	仓库内放笔记的文件夹	`.`(根目录)
`buildMode`	`full`——发布所有笔记;`public`——只发布 frontmatter 中带 `publish: public` 的笔记	`full`
`baseHref`	网站子路径。GitHub Pages 用 `/仓库名/`,Netlify/Vercel/Cloudflare 用 `/`	`/`
`out`	构建产物的输出位置	`dist`

设置优先级

CLI 的 flag 覆盖环境变量,环境变量覆盖配置文件,配置文件覆盖默认值。

隐藏笔记

在 buildMode: public 模式下,只有文件开头带有以下内容的笔记才会发布:

---
publish: public
---

其余的既不会出现在网站上,也不会进入搜索和图谱。

头号大坑——baseHref

如果网站能打开,但看起来一团糟、笔记加载不出来——几乎可以肯定是 baseHref 的问题。见 FAQ。