MARKDOWN.HTML

简体中文 | English

本项目旨在提供低依赖、一键部署的 Markdown 网页渲染方案。

特性

• 依赖少：仅需一个 HTML 文件，即可完成 Markdown 网页渲染。
• 代码高亮支持：渲染 Markdown 中的代码块。
• Markdown 支持：将 Markdown 文件渲染为 HTML。
• Mermaid 支持：将 Markdown 中的 Mermaid 语法渲染为图表。
• 多语言支持：支持多种语言间的机器互译。
• 深色模式：支持浅色、深色、跟随系统。
• Pjax 支持：支持无刷新页面跳转。

使用方法

文件名	说明
index.html	默认 HTML 入口文件，使用 CDN 引入依赖。
index.min.html	压缩后的 HTML 入口文件，使用 CDN 引入依赖。
index.allinone.html	全合一 HTML 入口文件，默认包含所有可被脚本下载的依赖。
index.allinone.min.html	压缩后的全合一 HTML 入口文件，默认包含所有可被脚本下载的依赖。

手动部署

1. 在发行页面下载并重命名您需要的 HTML 文件到你的网站根目录或任何其他目录中；
2. 当下载并重命名后的 HTML 被访问时，将自动渲染同目录下的 index.md，如果 index.md 不存在，则渲染 README.md。

Github Actions

编译并把 HTML 放入指定目录。使用时须将 <version> 替换为版本号。

- name: Deploy markdown.html
  uses: PJ-568/MARKDOWN.HTML@v<version>
  with:
    target-dir: '.'
    file-name: 'index.html'
    use-minified: 'true'
    use-all-in-one: 'false'

其他说明

本项目使用的开源项目允许修改，但请保留原作者信息。确需去除，请联系作者，以免失去技术支持。详情请参照许可证。

代码或内容贡献

欢迎每一位对本项目感兴趣的朋友贡献代码和内容。 请参阅程序逻辑、清单、脚本与主程序设计分析和工作流程，并确保你的贡献符合项目规范。

较为简单的提交贡献方法可查阅贡献文档以了解相关信息。

许可证

本项目遵循 CC BY-SA 4.0 International 许可协议。如果想了解完整许可信息，请查阅 LICENSE 文件。

鸣谢

项目

名称	协议	地址
tabler-icons	MIT License	Github、Website
highlightjs/highlight.js	BSD-3-Clause license	Github、Website
markedjs/marked	marked License	Github、Website
mermaidjs/mermaid	MIT License	Github、Website
translate.js	Apache License Version 2.0	Github、Gitee、Website
darkmode.js	MIT license	Github、Website
MoOx/pjax	MIT license	Github
instant.page	MIT license	Github、Website
Maple Mono	OFL-1.1 license	Github、Website

服务

图标	名称
无	360 前端静态资源库
	字节跳动静态资源公共库
	中文网字计划

星