{"id":26418804,"url":"https://github.com/karinjs/karin-plugin-markdown","last_synced_at":"2025-03-18T01:54:41.460Z","repository":{"id":241576271,"uuid":"807026748","full_name":"KarinJS/karin-plugin-markdown","owner":"KarinJS","description":"将文本转为 Github Markdown 风格的图片","archived":false,"fork":false,"pushed_at":"2024-05-28T13:42:27.000Z","size":1159,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-29T04:50:48.585Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KarinJS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-28T10:50:27.000Z","updated_at":"2024-05-30T15:49:42.203Z","dependencies_parsed_at":"2024-05-30T15:49:38.249Z","dependency_job_id":"4775f2f8-66f9-4464-bf33-9cdf1f0a7b4d","html_url":"https://github.com/KarinJS/karin-plugin-markdown","commit_stats":null,"previous_names":["karinjs/karin-plugin-markdown"],"tags_count":0,"template":false,"template_full_name":"KarinJS/karin-plugin-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarinJS%2Fkarin-plugin-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarinJS%2Fkarin-plugin-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarinJS%2Fkarin-plugin-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarinJS%2Fkarin-plugin-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KarinJS","download_url":"https://codeload.github.com/KarinJS/karin-plugin-markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244141583,"owners_count":20404835,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-18T01:54:41.001Z","updated_at":"2025-03-18T01:54:41.413Z","avatar_url":"https://github.com/KarinJS.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown 转图\n\n使用`puppeteer`将`markdown`转换为图片\n\n---\n\n## 安装插件\n\nkarin 根目录执行以下命令即可开箱使用\n\n```bash\npnpm add @karinjs/plugin-markdown -w\n```\n\n## 有一些基础配置\n\n\u003e 你可以在`karin/config/plugin/@karinjs/plugin-markdown/config.yaml`中配置\n\n```yaml\n# 权限配置 \"master\" | \"admin\" | \"group.owner\" | \"group.admin\" | \"all\"\npermission: master\n\n# 像素比 越高越清晰 但是会减缓渲染速度\ndeviceScaleFactor: 3\n\n# 页面加载状态 'load'|'domcontentloaded'|'networkidle0'|'networkidle2'\n# load: 页面完全加载\n# domcontentloaded: DOMContentLoaded 事件触发 如果纯静态可以使用\n# networkidle0: 500ms内没有网络连接\n# networkidle2: 500ms内网络连接数小于2\nwaitUntil: networkidle2\n\n# markedKatex配置 详情查看https://katex.org/docs/options.html\nmarkedKatex:\n  # 输出格式 html | mathml | htmlAndMathml\n  output: htmlAndMathml\n  throwOnError: false\n\n\n```\n\n## 指令\n\n`#md + markdown内容`\n\n`#md + 任何文件`\n\n举例：\n\n\u003cdetails\u003e\n\u003csummary\u003e点击展开查看高级示例\u003c/summary\u003e\n\n```txt\n#md # 地球的安可\u003cdiv style=\"display: flex;\"\u003e\n\u003cp align=\"left\"\u003e\n  \u003cimg src=\"https://prod-alicdn-community.kurobbs.com/forum/e93296bb45e74a0e9e523120e317794620240521.png\" width=\"700\" height=\"700\" align=\"center\"\u003e\n\u003c/p\u003e\n\u003cdiv\u003e\n\n## 想要看我的私房照吗？\n\n\n\u003e 使用技能\n\n| 参数名 | 参数类型 |\n| ------ | ------ |\n| 敌人id  | int   |\n| 是否长按  | bool   |\n\n\u003cdetails\u003e\n \u003csummary\u003e安可私房照\u003c/summary\u003e\n\u003c/details\u003e\n\n\u003c/div\u003e\n\u003cdiv style=\"margin-left: 20px; padding-left: 10px; border-left: 1px solid grey;\"\u003e\n\u003cdiv style=\"color: green; font-size: 18px; font-weight: bold\"\u003e\n地球的安可\n\u003c/div\u003e\n\u003cdiv\u003e\n地球生物\u003c/div\u003e\n\u003c/div\u003e\n\u003c/div\u003e\n```\n\n\u003c/details\u003e\n\n### 效果展示\n\n\u003cdetails\u003e\n\u003csummary\u003e点击展开图片查看效果\u003c/summary\u003e\n\n![图片][效果展示]\n\n\u003c/details\u003e\n\n## 进阶\n\n当然支持导出使用啦~\n\n举例: 在`karin-plugin-example`中随便新建一个 js 文件\n\n```js\nimport fs from \"fs\";\nimport markdown from \"../karin-plugin-markdown/index.js\";\n\nconst image = await markdown(\"# Hello, world!\");\n// 保存到本地 base64\nfs.writeFileSync(\"./image.jpeg\", image.replace(\"base64://\", \"\"), \"base64\");\n```\n\n你会在根目录看到一个`image.jpeg`文件~\n\n### 更多参数\n\n```js\nimport fs from \"fs\";\nimport markdown from \"../karin-plugin-markdown/index.js\";\n\nconst image = await markdown(\"# Hello, world!\", {\n  theme: 2, // 主题设置 0跟随系统 1白天 2黑夜\n  waitUntil: \"networkidle0\", // \"networkidle0\" | \"load\" | \"domcontentloaded\" | \"networkidle2\"\n  deviceScaleFactor: 10, // 像素比 越大越清晰 渲染速度越慢\n});\n// 保存到本地 base64\nfs.writeFileSync(\"./image.jpeg\", image.replace(\"base64://\", \"\"), \"base64\");\n```\n\n## 资源来源\n\n- `highlight.min.js`:\n  - [原始源][highlight.min.js]\n  - [GitHub][Github-highlight.min.js]\n- `github.min.css`:\n  - [原始源][github.min.css]\n  - [GitHub][Github-highlight.min.js]\n- `katex.min.css`:\n  - [原始源][katex.min.css]\n  - [GitHub][Github-katex.min.css]\n- `tex-mml-chtml.js`:\n  - [原始源][tex-mml-chtml.js]\n  - [GitHub][Github-tex-mml-chtml.js]\n\n[效果展示]: https://gchat.qpic.cn/gchatpic_new/473893141/2171986905-3016544360-EFA0C041E2496809C8369DCACE68A1E1/0?term=2\u0026is_origin=1\n[highlight.min.js]: https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/highlight.min.js\n[github.min.css]: https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/styles/github.min.css\n[katex.min.css]: https://cdn.jsdelivr.net/npm/katex@0.16.8/dist/katex.min.css\n[tex-mml-chtml.js]: https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js\n\n[Github-highlight.min.js]: https://github.com/highlightjs/highlight.js\n[Github-katex.min.css]: https://github.com/linxiaowu66/marked-kaTex\n[Github-tex-mml-chtml.js]: https://github.com/mathjax/MathJax\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarinjs%2Fkarin-plugin-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarinjs%2Fkarin-plugin-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarinjs%2Fkarin-plugin-markdown/lists"}