0

0

将 Starlight 转换为 PDF:经验和见解

DDD

DDD

发布时间:2025-01-15 08:05:44

|

1061人浏览过

|

来源于dev.to

转载

想象一下您收到一项任务:在一周内创建一个新的文档网站。它应该具有视觉吸引力、快速且易于导航。您会收到一堆 *.docs 文件、图像和屏幕截图,以及“完成它”.

的说明

有很多优秀的工具可供选择,例如docusaurusnextravitepressdocus等等。之前,我在使用 starlight 构建文档网站方面获得了丰富的经验,因此我选择了它来完成这项任务。然而,我发现了一个缺失的功能:从文档生成 pdf 的能力。这是要求之一。 “听起来像是一个不错的副业项目,”我自己想的。

解决任务

起初,这似乎很简单:获取页面,解析 html,对内容进行分组,瞧!

星光驱动的网站有一个“下一步”按钮来浏览文档。由于 pdf 本质上是页面数组,因此使用“下一步”按钮逐一解析它们似乎是合乎逻辑的。由于网站生成静态页面,我很快编写了一个脚本来获取 html、查询必要的部分,并将所有内容组合在一起。然而,事实证明,生成保留网站样式的 pdf 更为复杂。经过一番头脑风暴,我意识到 puppeteer 是最好的解决方案。

现在流程变得清晰了:

  1. 确定起始页面。这是带有“下一步”按钮的第一页。
  2. 浏览页面。从每个页面提取标题和主要内容,同时构建目录。
  3. 合并内容。添加分页符和其他样式。
  4. 准备最终的 html。 使用生成的 html 重写初始页面的 。
  5. 加载资源。滚动页面至底部加载所有图片。
  6. 生成 pdf。puppeteer 的 page.pdf() 方法可以解决这个问题。
  7. 完成!

这就是starlight-to-pdf 的工作原理。遵循这种模式,您可以为缺乏 pdf 导出功能的其他文档框架构建类似的工具。

后续步骤

基本功能准备就绪后,就该添加一些额外功能了。以下是最有趣和最具挑战性的功能。

添加页眉和页脚

页眉或页脚中包含页码和一些附加信息是很好的。 puppeteer 的 page.pdf() 方法接受 headertemplate 和 footertemplate 选项。这些选项接受 html 字符串。 puppeteer 自动将值注入到具有特定实用程序类的元素中:

  • .date:格式化日期;
  • .title:网页的标签值;
  • .url: 调用打印函数的页面 url;
  • .pagenumber:当前页码;
  • .totalpages: 文档的总页数。

当我们在打印之前将所有内容合并在一页上时,标题和网址对我们来说没有太大价值:插入的值将始终保持不变。然而,其他课程有很大帮​​助。这是页脚模板示例:




要使用此功能,请不要忘记将 displayheaderfooter 属性设置为 true:

import puppeteer from 'puppeteer';

const browser = await puppeteer.launch();
const page = await browser.newpage();
await page.goto('https://someurl');

const footertemplatestr = '

  • 图像应编码为 base64 字符串。
  • 使用 puppeteer 的边距选项来实现所需的布局。
  • cli 样式怎么样?

    一切正常,生成的 pdf 看起来很棒,但终端消息感觉平淡无奇。对细节的关注将好与伟大区分开来,不是吗?让我们的消息更加丰富多彩、更易于阅读。

    MiniMax Agent
    MiniMax Agent

    MiniMax平台推出的Agent智能体助手

    下载

    这就是 ansi 转义序列的魔力。我认为 4 位颜色足以完成这项工作。假设您想要红色背景上的白色文本(这就是我用于[错误]:错误消息之前的前缀)。以下是实现这种外观的方法:

    console.log('\x1b[37;41m', 'white on red message');
    

    让我们来分解一下:

    • x1b[ 是十六进制转义码(您也可以使用 u001b 作为 unicode 替代);
    • 37 是前景色白色,其中 3 代表前景色,7 代表白色;
    • 41 是背景红色,其中 4 代表背景,1 代表红色。

    一切正常,但现在我们所有的 console.log() 输出都将以这种方式设置样式。要将样式重置回默认值,只需在末尾添加重置序列 x1b[0m:

    console.log('\x1b[37;41m', 'white on red message', '\x1b[0m');
    

    好多了。如果我们想要在灰色背景上显示粗体青色文本(4 位颜色名称中的亮黑色),该怎么办?很简单:

    98262315536​​3

    以下是每个部分的作用:

    • 1 转义码后应用粗体效果;
    • 36 设置文本颜色为青色;
    • 100 将背景更改为亮黑色,其中 10 表示明亮,0 是黑色的代码。

    利用这些知识,您可以使您的 cli 工具在视觉上更具吸引力。例如,我在项目中将所有 url 和文件路径设置为带下划线的蓝色文本:

    console.log('\x1b[4;34m', './underlined/blue', '\x1b[0m')
    

    查看此备忘单以了解有关该主题的更多信息。

    总结

    你永远不知道日常任务什么时候可能会激发出有益的副业项目。 starlight-to-pdf 的开发为 puppeteer 和 cli 样式提供了宝贵的经验,并且开源社区中出现了一种新工具。这是一个快速演示:

    starlight-to-pdf usage demo

    相关专题

    更多
    css
    css

    css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

    521

    2023.06.15

    css居中
    css居中

    css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

    262

    2023.07.27

    css如何插入图片
    css如何插入图片

    cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

    753

    2023.07.28

    css超出显示...
    css超出显示...

    在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

    539

    2023.08.01

    css字体颜色
    css字体颜色

    CSS中,字体颜色可以通过属性color来设置,用于控制文本的前景色,字体颜色在网页设计中起到很重要的作用,具有以下表现作用:1、提升可读性;2、强调重点信息;3、营造氛围和美感;4、用于呈现品牌标识或与品牌形象相符的风格。

    757

    2023.08.10

    什么是css
    什么是css

    CSS是层叠样式表(Cascading Style Sheets)的缩写,是一种用于描述网页(或其他基于 XML 的文档)样式与布局的标记语言,CSS的作用和意义如下:1、分离样式和内容;2、页面加载速度优化;3、实现响应式设计;4、确保整个网站的风格和样式保持统一。

    603

    2023.08.10

    css三角形怎么写
    css三角形怎么写

    CSS可以通过多种方式实现三角形形状,本专题为大家提供css三角形怎么写的相关教程,大家可以免费体验。

    559

    2023.08.21

    css设置文字颜色
    css设置文字颜色

    CSS(层叠样式表)可以用于设置文字颜色,这样做有以下好处和优势:1、增加网页的可视化效果;2、突出显示某些重要的信息或关键字;3、增强品牌识别度;4、提高网页的可访问性;5、引起不同的情感共鸣。

    389

    2023.08.22

    Java 桌面应用开发(JavaFX 实战)
    Java 桌面应用开发(JavaFX 实战)

    本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

    36

    2026.01.14

    热门下载

    更多
    网站特效
    /
    网站源码
    /
    网站素材
    /
    前端模板

    精品课程

    更多
    相关推荐
    /
    热门推荐
    /
    最新课程
    Sass 教程
    Sass 教程

    共14课时 | 0.8万人学习

    Bootstrap 5教程
    Bootstrap 5教程

    共46课时 | 2.9万人学习

    CSS教程
    CSS教程

    共754课时 | 18.7万人学习

    关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
    php中文网:公益在线php培训,帮助PHP学习者快速成长!
    关注服务号 技术交流群
    PHP中文网订阅号
    每天精选资源文章推送

    Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号