MARKDOWN.HTML

MARKDOWN.HTML

本项目旨在提供低依赖、一键部署的 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> 替换为版本号。

1
2
3
4
5
6
7
- 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-iconsMIT LicenseGithubWebsite
highlightjs/highlight.jsBSD-3-Clause licenseGithubWebsite
markedjs/markedmarked LicenseGithubWebsite
mermaidjs/mermaidMIT LicenseGithubWebsite
translate.jsApache License Version 2.0GithubGiteeWebsite
darkmode.jsMIT licenseGithubWebsite
MoOx/pjaxMIT licenseGithub
instant.pageMIT licenseGithubWebsite
Maple MonoOFL-1.1 licenseGithubWebsite

服务

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

Stargazers over time

作者

PJ568

发布于

2024-12-19

更新于

2025-06-29

许可协议

评论