内容提要
作者介绍了一种基于CSS和JavaScript的轻量级HTML文章格式,可复用于任意网页,并可由litedown或Quarto生成。其主要特性包括侧边元素(目录、脚注、边注、参考文献)、全宽元素、浮动引文、边距嵌入和附录。
延伸解读
轻量格式的复用性
该文章格式基于CSS和JavaScript,可复用于任意网页,不依赖特定生成工具。作者提供了litedown和Quarto两种集成方式,并给出可直接复用的HTML代码片段。这意味着即使使用其他HTML生成器,也能通过引入相同的CSS和JS文件获得一致的排版效果,降低了跨平台适配成本。
侧边元素与全宽布局
格式支持侧边元素(目录、脚注、边注、参考文献)、全宽元素、浮动引文、边距嵌入和附录。这些特性适合学术写作或技术文档,能在不打断正文流的情况下展示补充信息。侧边栏和边注尤其有助于读者快速查阅注释,而全宽元素可用于突出图表或代码块。
生成工具的选择建议
若使用R Markdown或纯Markdown,可通过安装litedown包并指定输出格式快速启用;若使用Quarto,则需在YAML中配置minimal、toc及引入相关脚本和样式。两种方式均需加载sidenotes和appendix脚本以及default和article样式表。对于其他工具,直接复用Quarto示例中的HTML代码即可。
Q&A
如何用 litedown 包生成这种 HTML 文章格式?
安装 litedown 包(install.packages('litedown')),然后在输出格式中指定 litedown::html_format,并在 meta 中配置 css 为 ["default", "@article"],js 为 ["@sidenotes", "@appendix"]。
用 Quarto 怎么实现同样的文章格式?
在 Quarto 的 HTML 格式中设置 minimal: true 和 toc: true,并通过 include-after-body 引入相关的 JS 和 CSS 文件(如 sidenotes.min.js、appendix.min.js、default.min.css、article.min.css),还可以添加自定义样式。
这种文章格式有哪些主要特性?
主要特性包括:侧边元素(目录、脚注、边注、参考文献)、全宽元素、浮动引文、边距嵌入和附录。
这种格式底层是用什么技术实现的?可以复用到其他网页吗?
底层基于 CSS 和 JavaScript 实现,可以复用到任意网页上。
如果我用其他 HTML 生成器,如何复用这个文章格式?
可以复用上面 Quarto 示例中 text 字段里的 HTML 代码(即引入相关 CSS 和 JS 的链接),将其嵌入到你的 HTML 输出中即可。
在哪里可以查看这种文章格式的示例和文档?
可以访问作者提供的示例页面,该页面同时也是该格式的文档,包含详细说明。