发布网站

Tydora 可以把你的笔记仓库（Vault）一键发布为静态网站，无需搭建服务器，就能把知识库、文档或数字花园分享给任何人。生成的站点自带搜索、关系图谱与 Canvas 白板等能力。

Note

发布功能有两个入口：设置的「发布」标签，以及命令面板（Ctrl+P）中的「发布为网站」。底层由 @abstractwebunit/markdown-publish 构建为静态站点。

前置条件

发布功能依赖 @abstractwebunit/markdown-publish CLI。安装包不自带该 CLI，需要你先手动安装一次：

  1. 安装 Node.js（建议 18 及以上）。

  2. 在终端执行：

    npm install -g @abstractwebunit/markdown-publish

  3. 重启 Tydora。

Important

未安装时点击「发布」会提示「未找到 markdown-publish CLI」，并给出可一键复制的安装命令。CLI 依赖 Angular 等较大依赖，随安装包分发会让安装包从约 7 MB 膨胀到 20 MB 以上，因此改为按需安装。

Tip

Tydora 会按以下顺序查找 CLI：① 安装包资源目录（仅兼容旧版安装）→ ② 项目内的 vendor/ 与 node_modules/（开发环境）→ ③ 全局 npm 安装。开发时无需全局安装。

发布流程

  1. 配置发布设置：填写站点名称、描述、语言等基本信息，保存配置。
  2. 选择构建模式：全部发布，或仅公开笔记。
  3. 开始发布：点击「开始发布」/「生成站点」，界面会显示构建进度。
  4. 预览或部署：点「预览网站」在浏览器中查看，或把输出目录上传到任意静态托管服务。

构建模式

模式 说明
全部发布 发布仓库中的所有笔记，适合个人知识库、项目文档等「整库对外」的场景
仅公开笔记 仅发布 Frontmatter 中带 publish: public 的笔记，适合「同一仓库、选择性分享」

如何标记公开笔记：在文件开头写 publish: public，详见 02-编辑器/07-Frontmatter。

发布配置项

配置项 说明 默认值
站点名称 网站标题，如「我的笔记」 我的笔记
站点描述 简短描述站点内容，用于 SEO 笔记与想法
站点语言 站点默认语言：中文 / English / 日本語 / 한국어 中文
站点 URL 部署后的访问地址，用于绝对链接与 sitemap —
页脚署名 显示在页面底部的文字，留空则不显示 空
笔记目录 相对于仓库根目录，默认为根目录（.） .
构建模式 全部发布 / 仅公开笔记 全部发布
基础路径 GitHub Pages 用 /仓库名/，其他平台通常用 / /
输出目录 构建产物的输出位置，相对于仓库根目录 dist

配置会写入仓库中的 markdown-publish.config.json。界面提供「重置为默认」与「浏览」选择输出目录。

Tip

部署到 GitHub Pages 时，记得在「站点 URL」填 https://<用户名>.github.io/<仓库>/，并把「基础路径」填为 /<仓库>/，否则资源路径会 404。

预览与产出

操作 说明
预览网站 启动内置 HTTP 服务器，在浏览器中查看构建结果
停止预览 关闭预览服务器
打开输出目录 在系统文件管理器中打开构建产物目录

构建产物是纯静态文件，可托管到任意支持静态文件的服务：

平台 说明
GitHub Pages 免费，支持自定义域名
Vercel 一键部署，全球 CDN
Netlify 支持表单与函数
自有服务器 任意 HTTP 服务器（Nginx / Apache 等）

发布后的站点能力

  • 保留 03-知识管理/01-Wiki链接 在站点内的导航能力
  • 内置搜索
  • 关系图谱
  • Canvas 白板
  • Callout、Mermaid、数学公式等富元素正常渲染

相关文档