开源项目Gimli简介及新手使用指南

开源项目Gimli简介及新手使用指南

gimli Utility for converting markup files to pdf files 项目地址: https://gitcode.com/gh_mirrors/giml/gimli

项目基础介绍

Gimli是一款由[优快云公司开发的InsCode AI大模型]基于Ruby编写的开源工具，专为将各种标记语言文件转换为PDF格式而设计。它扩展了原有的textile2pdf功能，支持多种标记风格，并加入了语法高亮特性。灵感来源于gollum的标记转换功能，Gimli利用GitHub-Markup来处理文本标记，并借助wkhtmltopdf将HTML转换成PDF文档。项目遵循MIT许可证。

主要编程语言: Ruby

新手使用注意事项及解决方案

注意事项1：环境配置

• 问题描述: 新手可能会遇到因缺少依赖（如wkhtmltopdf）而导致的运行失败。
• 解决步骤:
  1. 访问wkhtmltopdf官方网站下载对应操作系统的可执行文件。
  2. 确保wkhtmltopdf的路径已添加到系统环境变量$PATH中，以便Gimli能够找到它。
  3. 对于Windows用户，还需安装GnuWin32中的which命令，同样将其路径添加至$PATH。

注意事项2：CSS样式应用

• 问题描述: 初次使用者可能不清楚如何自定义PDF的外观。
• 解决步骤:
  1. 在项目目录下创建一个名为gimli.css的文件，编写你的CSS样式。
  2. 运行Gimli时如果不指定 -s 标志，则默认使用该CSS文件。
  3. 若想使用其他CSS文件，可通过命令行加入 -s 路径/你的css文件名.css 来指定。

注意事项3：图片路径引用

• 问题描述: 图片路径不正确可能导致PDF生成时图片无法显示。
• 解决步骤:
  1. 使用绝对路径或确保相对路径是从当前Markdown文件算起的。
  2. 网络图片需提供完整URL，本地图片则确保其路径对Gimli是可达的。
  3. 对于相对路径，确保MarkDown文件和图片位于相同或正确的相对关系位置中。

通过关注这些关键点，新用户可以更顺畅地开始使用Gimli进行标记文件到PDF的转换过程。记得查看项目的GitHub页面以获取最新信息和更新。

gimli Utility for converting markup files to pdf files 项目地址: https://gitcode.com/gh_mirrors/giml/gimli