rich-codex 使用教程

rich-codex 使用教程

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

1. 项目介绍

rich-codex 是一个用于生成终端窗口截图的 GitHub Action 和命令行工具。它可以帮助你在文档中嵌入命令输出或代码片段的截图，从而更直观地展示工具的使用效果。rich-codex 支持在本地运行，也可以通过 GitHub Actions 自动生成并提交截图到仓库。

2. 项目快速启动

安装

你可以通过 pip 安装 rich-codex：

pip install rich-codex

基本使用

安装完成后，你可以直接在命令行中运行 rich-codex，它会递归搜索当前工作目录中的内容并生成截图：

rich-codex

生成 PNG 或 PDF 图片

如果你需要生成 PNG 或 PDF 图片，需要安装额外的依赖：

pip install rich-codex[cairo]

配置 GitHub Action

你可以在 GitHub Actions 中配置 rich-codex 来自动生成截图并提交到仓库：

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"

3. 应用案例和最佳实践

在文档中嵌入命令输出

假设你有一个命令 cat cat.txt | lolcat -S 1，你可以通过 rich-codex 生成截图并在 Markdown 文档中引用：

![`cat cat.txt | lolcat -S 1`](img/cat.svg)

自动生成并提交截图

通过配置 GitHub Action，你可以在每次代码推送时自动生成截图并提交到仓库，确保文档中的截图始终是最新的。

4. 典型生态项目

Textualize/rich

rich-codex 使用 Textualize/rich 库来渲染终端输出为图片。Textualize/rich 是一个强大的 Python 库，用于在终端中生成丰富的文本和格式化输出。

CairoSVG

如果你需要生成 PNG 或 PDF 图片，rich-codex 依赖于 CairoSVG 进行图片转换。CairoSVG 是一个用于将 SVG 转换为其他格式的 Python 库。

通过这些工具的结合使用，你可以轻松地在文档中嵌入高质量的终端截图，提升文档的可读性和用户体验。

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