Skip to content

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

License

Notifications You must be signed in to change notification settings

PJ-568/MARKDOWN.HTML

Repository files navigation

MARKDOWN.HTML

简体中文 | English

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

特性

  • 少依赖:仅需一个 HTML 文件、少量 CDN 和服务器程序,即可完成 Markdown 网页渲染。
  • 多语言支持:支持多种语言间的机器互译。
  • 深色模式:支持浅色、深色、跟随系统。
  • Pjax 支持:支持无刷新页面跳转。

使用方法

  1. 下载并重命名本仓库的 index.html 文件到你的网站根目录或任何其他目录中;
  2. 当下载并重命名后的 index.html 被访问时,将自动渲染同目录下的 index.md,如果 index.md 不存在,则渲染 README.md

其他说明

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

代码或内容贡献

欢迎每一位对本项目感兴趣的朋友贡献代码和内容。 请参阅程序逻辑

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

许可证

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

附加许可证

名称 协议 地址
tabler-icons MIT License https://github.com/tabler/tabler-icons
markedjs/marked marked License Github
translate.js Apache License Version 2.0 GithubGitee
darkmode.js MIT license Github
MoOx/pjax MIT license Github
instant.page MIT license Github