在 Sourcehut 上将 README.org 渲染为 HTML

主要观点:将README.org导出为 HTML 的 Elisp 代码放在 Makefile 中可简化打包流程,无需额外的.el文件供 lint 工具和编译器抱怨,该想法归功于 Jonas Bernoulli。
关键信息:

  • 在项目根目录添加名为Makefile的文件,如hyperdrive.el Makefile,其中定义了相关环境变量和导出 HTML 的命令。
  • README.html: README.org表示依赖关系,通过$(BATCH)命令进行转换。
  • .builds/子目录添加readme.yml文件,如hyperdrive.el.builds/readme.yml,指定构建脚本所需的信息,包括镜像、安装包、源和任务等,其中任务为在hyperdrive.el目录中执行make README.htmlhut git update --readme README.html
    重要细节:
  • EMACS为 Emacs 路径,EMACSQ为不带 GUI 的 Emacs 路径,BATCH定义了一系列 Emacs 命令参数用于处理README.org并导出为 HTML。
  • 构建脚本可安装hutemacs,克隆仓库,导出README.html并设置自定义 README。
阅读 8
0 条评论