介绍

SDoc 由两部分组成:第一部分是一个极简静态网站生成器,它包含由 San 驱动的主题系统和插件 API,另一个部分是为书写技术文档而优化的默认主题,它的诞生初衷是为了支持 San 及其子项目的文档需求。

每一个由 SDoc 生成的页面都带有预渲染好的 HTML,也因此具有非常好的加载性能和搜索引擎优化(SEO)。同时,一旦页面被加载,San 将接管这些静态内容,并将其转换成一个完整的单页应用(SPA),其他的页面则会只在用户浏览到的时候才按需加载。

它是如何工作的?

事实上,一个 SDoc 网站是一个由 San、San Router 和 webpack 驱动的单页应用。如果你以前使用过 San 的话,当你在开发一个自定义主题的时候,你会感受到非常熟悉的开发体验,你甚至可以使用 San DevTools 去调试你的自定义主题。

在构建时,我们会为应用创建一个服务端渲染(SSR)的版本,然后通过虚拟访问每一条路径来渲染对应的HTML。