{"id":24078702,"url":"https://github.com/pj-568/markdown.html","last_synced_at":"2025-07-03T18:09:30.045Z","repository":{"id":260064805,"uuid":"880138797","full_name":"PJ-568/MARKDOWN.HTML","owner":"PJ-568","description":"Aimming to provide a low-dependency, simple deployment solution for rendering Markdown web pages.","archived":false,"fork":false,"pushed_at":"2025-06-28T11:07:11.000Z","size":238,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-28T12:22:01.388Z","etag":null,"topics":["blog-engine","blog-platform","darkmode-js","highlight","highlight-js","highlightjs","html","html-css-javascript","instant-page","javascript","markdown","marked","marked-js","markedjs","mermaid","mermaidjs","pjax","tabler-icons","translatejs","web"],"latest_commit_sha":null,"homepage":"http://markdown-html.js.org/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PJ-568.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"zenodo":null}},"created_at":"2024-10-29T07:29:16.000Z","updated_at":"2025-06-28T11:07:00.000Z","dependencies_parsed_at":"2025-02-24T04:21:11.384Z","dependency_job_id":"12045ed5-ff8d-43c6-87f4-da05eababc5e","html_url":"https://github.com/PJ-568/MARKDOWN.HTML","commit_stats":null,"previous_names":["pj-568/markdown.html"],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/PJ-568/MARKDOWN.HTML","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PJ-568%2FMARKDOWN.HTML","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PJ-568%2FMARKDOWN.HTML/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PJ-568%2FMARKDOWN.HTML/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PJ-568%2FMARKDOWN.HTML/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PJ-568","download_url":"https://codeload.github.com/PJ-568/MARKDOWN.HTML/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PJ-568%2FMARKDOWN.HTML/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263376125,"owners_count":23457333,"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":["blog-engine","blog-platform","darkmode-js","highlight","highlight-js","highlightjs","html","html-css-javascript","instant-page","javascript","markdown","marked","marked-js","markedjs","mermaid","mermaidjs","pjax","tabler-icons","translatejs","web"],"created_at":"2025-01-09T21:56:25.912Z","updated_at":"2025-07-03T18:09:30.033Z","avatar_url":"https://github.com/PJ-568.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MARKDOWN.HTML\n\n\u003e 简体中文 | [English](README_EN.md)\n\n本项目旨在提供低依赖、一键部署的 Markdown 网页渲染方案。\n\n## 特性\n\n- **依赖少**：仅需一个 HTML 文件，即可完成 Markdown 网页渲染。\n- **代码高亮支持**：渲染 Markdown 中的代码块。\n- **Markdown 支持**：将 Markdown 文件渲染为 HTML。\n- **Mermaid 支持**：将 Markdown 中的 Mermaid 语法渲染为图表。\n- **多语言支持**：支持多种语言间的机器互译。\n- **深色模式**：支持浅色、深色、跟随系统。\n- **Pjax 支持**：支持无刷新页面跳转。\n\n## 使用方法\n\n| 文件名 | 说明 |\n| :----- | :--- |\n| [index.html](index.html) | 默认 HTML 入口文件，使用 CDN 引入依赖。 |\n| [index.min.html](index.min.html) | 压缩后的 HTML 入口文件，使用 CDN 引入依赖。 |\n| [index.allinone.html](index.allinone.html) | 全合一 HTML 入口文件，默认包含所有可被脚本下载的依赖。 |\n| [index.allinone.min.html](index.allinone.min.html) | 压缩后的全合一 HTML 入口文件，默认包含所有可被脚本下载的依赖。 |\n\n### 手动部署\n\n1. 在[发行页面](https://github.com/PJ-568/MARKDOWN.HTML/releases)下载并重命名您需要的 HTML 文件到你的网站根目录或任何其他目录中；\n2. 当下载并重命名后的 HTML 被访问时，将自动渲染同目录下的 `index.md`，如果 `index.md` 不存在，则渲染 `README.md`。\n\n### Github Actions\n\n编译并把 HTML 放入指定目录。使用时须将 `\u003cversion\u003e` 替换为版本号。\n\n```yaml\n- name: Deploy markdown.html\n  uses: PJ-568/MARKDOWN.HTML@v\u003cversion\u003e\n  with:\n    target-dir: '.'\n    file-name: 'index.html'\n    use-minified: 'true'\n    use-all-in-one: 'false'\n```\n\n## 其他说明\n\n`本项目使用的开源项目允许修改，但请保留原作者信息。确需去除，请联系作者，以免失去技术支持。`详情请参照[许可证](#许可证)。\n\n## 代码或内容贡献\n\n欢迎每一位对本项目感兴趣的朋友贡献代码和内容。\n请参阅[程序逻辑](doc/logic.md)、[清单](doc/TODO.md)、[脚本与主程序设计分析](doc/scripts.md)和[工作流程](doc/workflow.md)，并确保你的贡献符合项目规范。\n\n较为简单的提交贡献方法可查阅[贡献文档](CONTRIBUTING.md)以了解相关信息。\n\n## 许可证\n\n本项目遵循 [CC BY-SA 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) 许可协议。如果想了解完整许可信息，请查阅 [`LICENSE`](LICENSE) 文件。\n\n### 鸣谢\n\n#### 项目\n\n|名称|协议|地址|\n|:-:|:--|:--|\n|tabler-icons|[MIT License](//mit-license.org)|[Github](https://github.com/tabler/tabler-icons)、[Website](https://tabler.io/icons)|\n|highlightjs/highlight.js|[BSD-3-Clause license](https://github.com/highlightjs/highlight.js/raw/refs/heads/main/LICENSE)|[Github](https://github.com/highlightjs/highlight.js)、[Website](https://highlightjs.org)|\n|markedjs/marked|[marked License](https://github.com/markedjs/marked/blob/master/LICENSE.md)|[Github](https://github.com/markedjs/marked)、[Website](https://marked.js.org)|\n|mermaidjs/mermaid|[MIT License](https://github.com/mermaid-js/mermaid/blob/develop/LICENSE)|[Github](https://github.com/mermaid-js/mermaid)、[Website](https://mermaid.js.org)|\n|translate.js|[Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)|[Github](https://github.com/xnx3/translate)、[Gitee](https://gitee.com/mail_osc/translate)、[Website](https://translate.zvo.cn)|\n|darkmode.js|[MIT license](//mit-license.org)|[Github](https://github.com/sandoche/Darkmode.js)、[Website](https://darkmodejs.learn.uno)|\n|MoOx/pjax|[MIT license](//mit-license.org)|[Github](https://github.com/MoOx/pjax)|\n|instant.page|[MIT license](//mit-license.org)|[Github](https://github.com/instantpage/instant.page)、[Website](https://instant.page)|\n|Maple Mono|[OFL-1.1 license](https://openfontlicense.org/open-font-license-official-text/)|[Github](https://github.com/subframe7536/maple-font)、[Website](https://font.subf.dev)|\n\n#### 服务\n\n|图标|名称|\n|:-:|:--|\n|无|[360 前端静态资源库](https://cdn.baomitu.com/)|\n|![字节跳动静态资源公共库图标](https://cdn.bytedance.com/src/res/logo.svg)|[字节跳动静态资源公共库](https://cdn.bytedance.com/)|\n|![中文网字计划](https://chinese-font.netlify.app/favicon.ico)|[中文网字计划](https://chinese-font.netlify.app)|\n\n## 星\n\n[![Stargazers over time](https://starchart.cc/PJ-568/MARKDOWN.HTML.svg?variant=adaptive)](https://starchart.cc/PJ-568/MARKDOWN.HTML)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpj-568%2Fmarkdown.html","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpj-568%2Fmarkdown.html","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpj-568%2Fmarkdown.html/lists"}