文档中心
这里收录 XFM 开源项目的技术文档:两套 Hexo 主题、自研静态站点生成器,以及官方技术文档的中文整理教程。各分区彼此独立:
关于「项目」分区
「主题」与「教程」收录本开源主题与第三方官方文档的整理;「项目」收录本站作者自研项目的官方文档,随项目版本同步更新,内容基于源码与 CHANGELOG 而非二手资料。
目前收录:xfmpress。
一、主题 · hexo-theme-xfm
面向长期写作的三模式主题。文档位于 /docs/xfm/,按下面的目录组织:
二、主题 · hexo-theme-xongyi
面向机构官网的通用主题。文档位于 /docs/xongyi/:
三、教程 · TypeScript
官方文档的中文整理,位于 /docs/ts/。按官方 Handbook 的推荐顺序编排:
四、教程 · Rust
官方教程《The Rust Programming Language》的中文整理,位于 /docs/rust/。按学习曲线编排,重点铺平所有权这条最陡的坡:
- 模块系统 —— 包、crate 与可见性
- 常用集合 —— Vec、String、HashMap
- 错误处理 —— panic!、Result 与 ?
- 泛型、Trait 与生命周期 —— 抽象三支点
- 闭包与迭代器 —— 惰性求值与零成本抽象
五、项目 · xfmpress
自研的静态站点生成器官方文档,位于 /docs/xfmpress/。对应 v0.4.13,从安装一路写到内部架构:
- 内容与 Markdown —— front-matter 与扩展语法
- 模板语法 —— 过滤器、控制结构、继承
- 主题开发 —— 布局清单与最小主题
- 插件 —— 六个钩子与 15 个官方插件
阅读方式
左侧文档树由站点根目录的 source/_data/docs.yml 驱动,每个分区一个顶层分组(主题 / 教程 / 项目 / English),其下按章节递归展开。文档页支持「上一章 / 下一页」翻页与右侧页内目录,底部提供「编辑此页」入口。
xfmpress 手册另有英文版:xfmpress Manual (English),章节与中文版一一对应,两版页面顶部可互相跳转。
站点本身用了哪套主题?
本站由 hexo-theme-xfm 的 docs 模式驱动,采用「目录 + index.md」的 pretty URL 形式,文档页在 front-matter 中声明 mode: docs 以覆盖站点默认的 blog 形态。
文档仍在持续完善。若发现错误或有建议,欢迎通过页面底部的「编辑此页」提交修改。
评论