项目简介
本项目是基于 painter 和 highlight.js 实现的代码高亮图片生成工具,可帮助用户快速将代码片段转换为带有高亮效果的图片,便于在不支持代码高亮的平台分享代码,还能作为 VSCode 插件使用。
项目的主要特性和功能
- 支持多种编程语言代码的高亮显示。
- 能灵活定制生成图片的样式,包括背景、宽高、边框等。
- 提供简洁的 API 接口,方便集成到各类项目。
- 具备跨平台特性,可在浏览器和 Node.js 环境中使用。
安装使用步骤
安装依赖
已下载本项目源码文件后,通过 npm 或 yarn 安装项目依赖:
bash
npm install painter-highlight
yarn add painter-highlight
引用和使用
在项目里引入 painter-highlight
:
javascript
import phl from 'painter-highlight';
使用示例
以 Vue 项目为例,使用 phl
函数时需传入 canvas 元素、canvas 上下文、样式模板、代码内容和代码语言。
配置说明
template
可配置的属性有背景、宽度、高度和边框半径,宽度和高度支持自动判断或指定具体值。
待开发功能
- 实现代码宽度和高度的自动判断。
- 部署在线服务,支持直接转换代码。
- 开发自定义主题功能。
贡献指南
- Fork 本仓库。
- 创建 Feat_xxx 分支。
- 提交代码。
- 创建 Pull Request。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】