参考索引

按任务查找 Folio 公共 API、Frontmatter 字段、静态构建、部署、案例与附录。

Tomz Dang约 2 分钟

这一侧是查到具体事实的阅读模式:字段、边界、构建阶段、部署条件。如果你要的是按顺序读懂的路径,去 指南;本页只负责把参考材料按任务组织起来,不重复产品介绍。

Canonical identity#

repository     uichat-mira/folio
package        @uichat-mira/folio
vite module    virtual:folio/content
runtime        FolioApp
plugin         folio()

当前公开版本是 0.1.1。dev 源码可能包含尚未发布的候选契约,相关页面会单独标注。

按任务查找#

任务 文档
查 Frontmatter 字段和默认值 Frontmatter 参考
查看内置 React 组件、公开 API 与能力边界 组件
接入 Vite plugin、理解构建阶段 Vite 构建集成
生成静态 HTML、metadata、sitemap 与 robots 静态构建与 SEO
发布到 GitHub Pages 或下游平台 部署到 GitHub Pages、Cloudflare Pages 案例
查看 MiraDocs → Folio 迁移事实 迁移状态
维护官方站文档 官方站点内容维护约定

要按顺序读懂,去指南#

下面这些页面讲的是“怎么用”,因此归在 指南,不在这里重复:

任务 文档
安装、运行仓库或接入 consumer 快速开始
编写文档、文章、项目和页面 编写内容
选择内容类型、理解文件到路由的映射 内容类型与路由
写 Frontmatter、日期、作者与扩展字段 Frontmatter 与元数据
组织侧栏分组与阅读顺序 内容组织与排序
理解 FolioDoc、路径和类型推断 内容模型
配置导航、分组、排序和首页 站点配置与扩展、导航与内容清单
使用 Markdown、Callout、Mermaid 与标题锚点 Markdown 写作
组合 React runtime 与 official site 只用公开 API 组合站点
生成静态 HTML 的完整流程 静态发布

公开入口#

  • @uichat-mira/folio:内容解析、配置 helper、React runtime、Markdown 渲染、搜索与文档结构。
  • @uichat-mira/folio/vite:folio() Vite plugin、virtual:folio/content 与静态构建 helper。
  • @uichat-mira/folio/styles.css:whole-site 默认样式表,不是隔离的 embed stylesheet。

参考、案例与附录#

这些材料不是入门路径的替代品: