前言
本书展示技术书常见的工程化写法:共享属性、共享图片、本书图片、图表块和书内代码片段。
1. 构建流程
技术书仍然是一本文档边界独立的 book。它可以使用共享属性和共享图片,但自己的示例代码保留在书内。
共享工作区图来自 shared/images/:
本书自己的流程图来自书内资源:
2. 图表块
图表块让技术书把结构图保留为可维护文本。
Figure 1. Mermaid:技术书资源边界
3. 代码片段
代码片段属于本书内部资源。章节通过 include tag 引入需要进入书稿的片段。
export function describeBook(id) {
return `book:${id}`;
}
参考资料
-
[asciidoctor-include] Asciidoctor Docs, Include Directive, https://docs.asciidoctor.org/asciidoc/latest/directives/include/