Rich-codex：自动生成终端截图的利器

最新推荐文章于 2024-09-17 20:57:27 发布

喻昊沙Egerton

最新推荐文章于 2024-09-17 20:57:27 发布

阅读量1k

点赞数 28

本文链接：https://blog.csdn.net/gitblog_00655/article/details/142046623

版权

Rich-codex：自动生成终端截图的利器

rich-codexCreate rich code images for your docs.项目地址:https://gitcode.com/gh_mirrors/ri/rich-codex

项目介绍

在技术文档中，代码示例是帮助用户理解工具使用的重要方式。然而，手动生成和维护这些代码示例的截图既繁琐又容易出错。Rich-codex 是一个 GitHub Action 和命令行工具，能够自动生成包含命令输出或代码片段的终端截图，极大地简化了这一过程。

项目技术分析

Rich-codex 的核心功能是通过解析 Markdown 文件中的命令或代码片段，自动生成对应的终端截图。它支持多种输入方式，包括 Markdown 图片标签、Markdown 注释、命令行输入以及配置文件。生成的截图可以是 SVG、PNG 或 PDF 格式，且支持自动调整大小以适应不同的终端宽度。

Rich-codex 使用了 Textualize/rich 库来渲染终端输出，确保生成的截图具有丰富的色彩和格式。此外，Rich-codex 还支持通过 GitHub Action 自动运行并提交生成的截图，确保文档始终保持最新。

项目及技术应用场景

Rich-codex 适用于以下场景：

CLI 工具输出示例：自动生成并保持与代码同步的 CLI 工具输出截图，确保文档中的示例始终是最新的。
代码片段展示：自动生成并更新代码片段的截图，支持语法高亮，提升文档的可读性。
快速生成文档图片：无需复杂的设置，即可快速生成文档所需的终端截图，简化文档维护流程。

项目特点

自动化生成：Rich-codex 能够自动解析 Markdown 文件中的命令或代码片段，生成对应的终端截图，无需手动操作。
多种输入方式：支持通过 Markdown 图片标签、Markdown 注释、命令行输入以及配置文件等多种方式指定生成截图的内容。
格式灵活：生成的截图可以是 SVG、PNG 或 PDF 格式，满足不同文档的需求。
自动调整大小：支持自动调整截图大小，确保长行代码或输出不会被截断或滚动。
GitHub Action 集成：通过 GitHub Action 自动运行并提交生成的截图，确保文档始终保持最新。

快速开始

编写 Markdown 文档：在文档中使用图片标签并嵌入命令或代码片段。
```
![`cat docs/cat.txt | lolcat -S 1`](docs/img/cat.png)
```

添加 GitHub Action：配置 GitHub Action 自动运行命令，生成截图并提交到仓库。

on: [push]
jobs:
  rich_codex:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Install your custom tools
        run: pip install lolcat

      - name: Generate terminal images with rich-codex
        uses: ewels/rich-codex@v1
        with:
          commit_changes: "true"