Skip to content

Commit 05c15b0

Browse files
committed
【文档】更新文档
- 在 README.md 和 README_EN.md 中添加了代码高亮支持的特性说明 - 在依赖列表中加入了 highlightjs/highlight.js 的相关信息 - 更新了 index.html 中的 markdown-html 版本号至 1.13.1
1 parent de051e4 commit 05c15b0

3 files changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
## 特性
88

99
- **依赖少**:仅需一个 HTML 文件、少量 CDN 和服务器程序,即可完成 Markdown 网页渲染。
10+
- **代码高亮支持**:渲染 Markdown 中的代码块。
1011
- **Markdown 支持**:将 Markdown 文件渲染为 HTML。
1112
- **Mermaid 支持**:将 Markdown 中的 Mermaid 语法渲染为图表。
1213
- **多语言支持**:支持多种语言间的机器互译。
@@ -52,6 +53,7 @@
5253
|名称|协议|地址|
5354
|:-:|:--|:--|
5455
|tabler-icons|[MIT License](//mit-license.org)|[https://github.com/tabler/tabler-icons](https://github.com/tabler/tabler-icons)|
56+
|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)|
5557
|markedjs/marked|[marked License](https://github.com/markedjs/marked/blob/master/LICENSE.md)|[Github](https://github.com/markedjs/marked)|
5658
|mermaidjs/mermaid|[MIT License](https://github.com/mermaid-js/mermaid/blob/develop/LICENSE)|[Github](https://github.com/mermaid-js/mermaid)|
5759
|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)|

README_EN.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This project aims to provide a low-dependency, simple deployment solution for re
77
## Features
88

99
- **Low dependencies**: Only an HTML file, a small number of CDNs, and server programs are required to complete Markdown pages rendering.
10+
- **Syntax highlighting support**: Renders code blocks in Markdown.
1011
- **Markdown support**: Renders Markdown files into HTML.
1112
- **Mermaid support**: Renders Mermaid syntax in Markdown into diagrams.
1213
- **Multilingual support**: Supports machine translation between multiple languages.
@@ -52,6 +53,7 @@ This project is licensed under the [CC BY-SA 4.0 International](https://creative
5253
|Name|License|URL|
5354
|:-:|:--|:--|
5455
|tabler-icons|[MIT License](//mit-license.org)|[https://github.com/tabler/tabler-icons](https://github.com/tabler/tabler-icons)|
56+
|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)|
5557
|markedjs/marked|[marked License](https://github.com/markedjs/marked/blob/master/LICENSE.md)|[Github](https://github.com/markedjs/marked)|
5658
|mermaidjs/mermaid|[MIT License](https://github.com/mermaid-js/mermaid/blob/develop/LICENSE)|[Github](https://github.com/mermaid-js/mermaid)|
5759
|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)|

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!doctype html>
22

33
<html>
4-
<markdown-html version="1.13.0" author="PJ568" repo="https://github.com/PJ-568/markdown.html"
4+
<markdown-html version="1.13.1" author="PJ568" repo="https://github.com/PJ-568/markdown.html"
55
license="CC BY-SA 4.0 International"></markdown-html>
66

77
<head>

0 commit comments

Comments
 (0)