Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 2.36 KB

README_EN.md

File metadata and controls

43 lines (28 loc) · 2.36 KB

MARKDOWN.HTML

简体中文 | English

This project aims to provide a low-dependency, simple deployment solution for rendering Markdown web pages.

Features

  • Low dependencies: Only an HTML file, a small number of CDNs, and server programs are required to complete Markdown pages rendering.
  • Multilingual support: Supports machine translation between multiple languages.
  • Dark mode support: Supports light, dark, and system-following modes.
  • Pjax support: Supports page navigation without refreshing the whole page.

Usage

  1. Download and rename the index.html file from this repository and place to your website's root directory or any other directory;
  2. When the html file is accessed, it will automatically render the index.md in the same directory. If index.md does not exist, it will render README.md.

Additional Notes

The open-source projects used in this project allow modifications, but please retain the original author information. If removal is necessary, please contact the author to avoid losing technical support. For more details, refer to the license.

Code or Content Contributions

We welcome contributions of code and content from anyone interested in this project. Please checkout 程序逻辑.

For a simpler way to contribute, please refer to the Contribution Guide for relevant information.

License

This project is licensed under the CC BY-SA 4.0 International license. For full license information, please refer to the LICENSE file.

Additional Licenses

Name License Address
tabler-icons MIT License https://github.com/tabler/tabler-icons
markedjs/marked marked License Github
translate.js Apache License Version 2.0 Github、Gitee
darkmode.js MIT license Github
MoOx/pjax MIT license Github
instant.page MIT license Github