尧图网站设计 尧图网站设计YAOTU DESIGN
ARTICLE DETAIL

资讯详情

深耕网站设计与一线实操的经验洞察。

如何用 docsify-to-pdf 把 generative-ai-for-beginners 的课程站点导出为 PDF

如何用 docsify-to-pdf 把 generative-ai-for-beginners 的课程站点导出为 PDF 如何用 docsify-to-pdf 把 generative-ai-for-beginners 的课程站点导出为 PDF【免费下载链接】generative-ai-for-beginners21 Lessons, Get Started Building with Generative AI项目地址: https://gitcode.com/GitHub_Trending/ge/generative-ai-for-beginnersgenerative-ai-for-beginners 是一个 21 节的生成式 AI 课程仓库课程站点基于 docsify 构建index.html 通过 docsify 加载各课程目录下的 Markdown。仓库内置了docsify-to-pdf工具可以把这个站点转换成一个 PDF 文件产物默认落在仓库根目录下的pdf/readme.pdf。本文说明从安装依赖、理解配置到执行导出、确认产物的完整操作路径。站点与导出工具的对应关系导出前先确认三处文件的职责后面每一步都围绕它们展开index.htmldocsify 站点入口window.$docsify中设置了repo、relativePath: true并指定loadNavbar: docs/_navbar.md。站点内容来自各课程目录01-introduction-to-genai/到21-meta/下的README.md。docsifytopdf.jsdocsify-to-pdf的配置文件决定导出哪些页面、PDF 存到哪里、渲染参数是什么。package.jsonscripts中定义了convert脚本devDependencies中固定了docsify-to-pdf: 0.0.5。准备条件安装根级依赖在仓库根目录执行AGENTS.md 的 Node.js/TypeScript Setup 一节明确这是文档工具所用的根级依赖安装npm install这一步会安装package.json声明的依赖包括开发依赖docsify-to-pdf0.0.5安装后node_modules/.bin/docsify-to-pdf可执行文件即被就绪。根目录同时存在package-lock.json依赖版本会按锁文件解析。课程代码本身的运行还需要 Python 环境requirements.txt但导出 PDF 这一任务不依赖它可以跳过。配置说明docsifytopdf.js 各字段docsifytopdf.js 的完整内容如下逐行说明其作用module.exports { contents: [docs/_sidebar.md], // array of table of contents files path pathToPublic: pdf/readme.pdf, // path where pdf will stored pdfOptions: { margin: { top: 100px, bottom: 100px } }, // reference: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions removeTemp: true, // remove generated .md and .html or not emulateMedia: print, // mediaType, emulating by puppeteer for rendering pdf, print by default };contents目录页table of contents文件路径数组。docsify-to-pdf从这些文件解析出要导出的页面列表。当前配置指向 docs/_sidebar.md。pathToPublicPDF 的存放路径即仓库根目录下的pdf/readme.pdf。pdfOptions透传给渲染引擎的 PDF 选项这里设置了上下边距各100px配置注释指明该选项参照 Puppeteer 的page.pdf optionsAPI。removeTemp: true导出后删除工具生成的临时.md和.html文件。emulateMedia: print以print媒体类型渲染 PDF。需要注意的是docs/_sidebar.md 目前只包含一条侧边栏条目Introduction to Generative AI指向../01-introduction-to-genai/README.md。由于contents决定了导出的目录范围本次导出覆盖哪些页面完全取决于这个侧边栏文件里列了哪些条目想扩大导出范围需要修改contents指向的文件内容而配置文件本身只声明了这一个文件。执行导出在仓库根目录执行 AGENTS.md “Building Documentation Site” 一节给出的命令npm run convert该命令对应 package.json 中的脚本定义convert: node_modules/.bin/docsify-to-pdf等价于直接调用node_modules/.bin/docsify-to-pdf由后者读取根目录的 docsifytopdf.js 配置完成转换。结果验证检查仓库根目录下是否生成了pdf/readme.pdf这是pathToPublic指定的产物路径。打开 PDF 核对内容是否按docs/_sidebar.md所列条目组织页面是否按emulateMedia: print的打印样式渲染。由于配置了removeTemp: true转换过程中生成的临时.md和.html文件会被自动删除仓库根目录不会留下这些中间产物。限制与说明导出的页面范围由contents指向的侧边栏文件决定仓库文档没有提供逐课程导出的独立入口或筛选参数如需只导出部分课程或全部课程需要先调整docs/_sidebar.md或contents中的文件再运行npm run convert。站点通过 CDN 加载 docsify 相关脚本见 index.html 中的cdn.jsdelivr.net地址转换依赖本地已安装的docsify-to-pdf工具链仓库文档未对环境的其他限制做额外说明。若命令未执行成功可先回到准备条件一节确认npm install已在根目录完成使node_modules/.bin/docsify-to-pdf存在。【免费下载链接】generative-ai-for-beginners21 Lessons, Get Started Building with Generative AI项目地址: https://gitcode.com/GitHub_Trending/ge/generative-ai-for-beginners创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表