文档导航
InkStack 文档开始使用

产品概览

一套内容即代码、静态发布、共享阅读界面的双内容源博客。

InkStack 是什么

InkStack 将 Typst、Markdown 和 MDX 接入同一个博客。你选择适合文章的写作语言,站点负责统一的文章布局、目录、脚注、代码块、搜索与发布规则。

它是静态站点,不需要数据库或长期运行的应用服务器。文章和资源存放在 Git 仓库中;每次发布都经过内容校验、真实编译、产物检查和浏览器测试。公开网站与私有源码仓库可以同时存在。

选择写作方式

内容源适合的内容边界
Markdown笔记、技术文章、日常写作支持 GFM、公式、脚注;不接受原始 HTML
MDX需要自定义组件的文章可导入 Astro 组件、使用表达式;属于受信任代码
Typst数学、排版与可选 PDF复用 Glyphweave 编译;固定 Typst 0.15.0

三者共用文章 UI 与 DOM 契约。Typst 的 MathML/SVG 和 Markdown 的 KaTeX 是不同的数学表示,不承诺逐像素一致。

从文件到公开网页

Text
源文件与图片
  → 导入预检 → 草稿 → 本地预览
  → 发布构建 → GitHub PR → 门禁验收
  → main 合并 → 同一产物上传 → 公开网站

已有文件从快速开始进入。新建文章可直接选择 Markdown / MDX 或 Typst;完整流程见导入与发布。创建 PR 不等于上线,只有正式部署成功才表示网站已更新。

内置能力

  • 文章、归档、标签、个人介绍、RSS 摘要与订阅页。
  • 全文 Spotlight 搜索,索引只在构建时生成,浏览器按需加载。
  • 创作记录从公开文章的发布与更新日期派生,不是演示数据或 GitHub 贡献统计。
  • 构建期插件系统,为首页、文章、关于页和页脚提供具名插槽。
  • 正式产品手册,拥有独立搜索索引,不混入文章列表和 RSS。

理解项目边界

InkStack 不提供 CMS、访客上传、评论、分析服务或邮件群发。RSS 是阅读器订阅,不是邮件订阅。MDX 与插件可以执行构建代码,私有仓库本身不构成沙箱。

需要修改实现时,先读系统架构;需要运行和上线时,先读部署与运维及安全与信任。本手册描述当前实现,不把未来设想写成已提供的功能。