|
2 | 2 |
|
3 | 3 | > [简体中文](README.md) | English |
4 | 4 |
|
5 | | -This project aims to provide a low-dependency, simple deployment solution for rendering Markdown web pages. |
| 5 | +This project provides a low-dependency, one-click deployment solution for rendering Markdown to web pages. |
6 | 6 |
|
7 | 7 | ## Features |
8 | 8 |
|
9 | | -- **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. |
11 | | -- **Markdown support**: Renders Markdown files into HTML. |
12 | | -- **Mermaid support**: Renders Mermaid syntax in Markdown into diagrams. |
13 | | -- **Multilingual support**: Supports machine translation between multiple languages. |
14 | | -- **Dark mode support**: Supports light, dark, and system-following modes. |
15 | | -- **Pjax support**: Supports page navigation without refreshing the whole page. |
| 9 | +- **Minimal dependencies**: Only requires a single HTML file to render Markdown web pages. |
| 10 | +- **Code highlighting**: Supports syntax highlighting for code blocks in Markdown. |
| 11 | +- **Markdown support**: Renders Markdown files to HTML. |
| 12 | +- **Mermaid support**: Renders Mermaid diagrams in Markdown. |
| 13 | +- **Multi-language support**: Provides machine translation between languages. |
| 14 | +- **Dark mode**: Supports light, dark, and system theme modes. |
| 15 | +- **Pjax support**: Enables page navigation without full refresh. |
16 | 16 |
|
17 | 17 | ## Usage |
18 | 18 |
|
| 19 | +| Filename | Description | |
| 20 | +| :----- | :--- | |
| 21 | +| index.html | Default HTML entry file using CDN dependencies. | |
| 22 | +| index.min.html | Minified HTML entry file using CDN dependencies. | |
| 23 | +| index.allinone.html | All-in-one HTML entry file with embedded dependencies which can be downloaded by script. | |
| 24 | +| index.allinone.min.html | Minified all-in-one HTML entry file with embedded dependencies which can be downloaded by script. | |
| 25 | + |
19 | 26 | ### Manual Deployment |
20 | 27 |
|
21 | | -1. Download and rename the `index.html` file from this repository and place to your website's root directory or any other directory; |
22 | | -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`. |
| 28 | +1. Download the required HTML file from [Releases](https://github.com/PJ-568/MARKDOWN.HTML/releases) and place it in your website root directory; |
| 29 | +2. The HTML file will automatically render `index.md` in the same directory, or `README.md` if `index.md` doesn't exist. |
23 | 30 |
|
24 | 31 | ### Github Actions |
25 | 32 |
|
| 33 | +Compiles and deploys HTML files to specified directory. Replace `<version>` with actual version number. |
| 34 | + |
26 | 35 | ```yaml |
27 | 36 | - name: Deploy markdown.html |
28 | 37 | uses: PJ-568/MARKDOWN.HTML@v<version> |
29 | 38 | with: |
30 | 39 | target-dir: '.' |
31 | 40 | file-name: 'index.html' |
| 41 | + use-minified: 'true' |
| 42 | + use-all-in-one: 'false' |
32 | 43 | ``` |
33 | 44 |
|
34 | | -## Additional Notes |
| 45 | +## Notes |
35 | 46 |
|
36 | | -`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](#license). |
| 47 | +`This open-source project allows modifications but please retain original author information. If removal is necessary, please contact the author to avoid losing technical support.` See [License](#license) for details. |
37 | 48 |
|
38 | | -## Code or Content Contributions |
| 49 | +## Contributions |
39 | 50 |
|
40 | | -We welcome contributions of code and content from anyone interested in this project. |
41 | | -Please checkout [程序逻辑](doc/logic.md). |
| 51 | +We welcome contributions to code and content. Please refer to: |
42 | 52 |
|
43 | | -For a simpler way to contribute, please refer to the [Contribution Guide](CONTRIBUTING.md) for relevant information. |
| 53 | +- [Logic Documentation](doc/logic.md) |
| 54 | +- [Contribution Guidelines](CONTRIBUTING.md) |
44 | 55 |
|
45 | 56 | ## License |
46 | 57 |
|
47 | | -This project is licensed under the [CC BY-SA 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) license. For full license information, please refer to the [`LICENSE`](LICENSE) file. |
| 58 | +This project is licensed under [CC BY-SA 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/). For complete license information, see [`LICENSE`](LICENSE). |
48 | 59 |
|
49 | | -### Credits |
| 60 | +### Acknowledgments |
50 | 61 |
|
51 | 62 | #### Projects |
52 | 63 |
|
53 | | -|Name|License|URL| |
| 64 | +|Name|License|Links| |
54 | 65 | |:-:|:--|:--| |
55 | | -|tabler-icons|[MIT License](//mit-license.org)|[Github](https://github.com/tabler/tabler-icons)、[Website](https://tabler.io/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)、[Website](https://highlightjs.org)| |
57 | | -|markedjs/marked|[marked License](https://github.com/markedjs/marked/blob/master/LICENSE.md)|[Github](https://github.com/markedjs/marked)、[Website](https://marked.js.org)| |
58 | | -|mermaidjs/mermaid|[MIT License](https://github.com/mermaid-js/mermaid/blob/develop/LICENSE)|[Github](https://github.com/mermaid-js/mermaid)、[Website](https://mermaid.js.org)| |
59 | | -|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)、[Website](https://translate.zvo.cn)| |
60 | | -|darkmode.js|[MIT license](//mit-license.org)|[Github](https://github.com/sandoche/Darkmode.js)、[Website](https://darkmodejs.learn.uno)| |
| 66 | +|tabler-icons|[MIT License](//mit-license.org)|[Github](https://github.com/tabler/tabler-icons), [Website](https://tabler.io/icons)| |
| 67 | +|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), [Website](https://highlightjs.org)| |
| 68 | +|markedjs/marked|[marked License](https://github.com/markedjs/marked/blob/master/LICENSE.md)|[Github](https://github.com/markedjs/marked), [Website](https://marked.js.org)| |
| 69 | +|mermaidjs/mermaid|[MIT License](https://github.com/mermaid-js/mermaid/blob/develop/LICENSE)|[Github](https://github.com/mermaid-js/mermaid), [Website](https://mermaid.js.org)| |
| 70 | +|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), [Website](https://translate.zvo.cn)| |
| 71 | +|darkmode.js|[MIT license](//mit-license.org)|[Github](https://github.com/sandoche/Darkmode.js), [Website](https://darkmodejs.learn.uno)| |
61 | 72 | |MoOx/pjax|[MIT license](//mit-license.org)|[Github](https://github.com/MoOx/pjax)| |
62 | | -|instant.page|[MIT license](//mit-license.org)|[Github](https://github.com/instantpage/instant.page)、[Website](https://instant.page)| |
63 | | -|Maple Mono|[OFL-1.1 license](https://openfontlicense.org/open-font-license-official-text/)|[Github](https://github.com/subframe7536/maple-font)、[Website](https://font.subf.dev)| |
| 73 | +|instant.page|[MIT license](//mit-license.org)|[Github](https://github.com/instantpage/instant.page), [Website](https://instant.page)| |
| 74 | +|Maple Mono|[OFL-1.1 license](https://openfontlicense.org/open-font-license-official-text/)|[Github](https://github.com/subframe7536/maple-font), [Website](https://font.subf.dev)| |
64 | 75 |
|
65 | 76 | #### Services |
66 | 77 |
|
67 | 78 | |Icon|Name| |
68 | 79 | |:-:|:--| |
69 | | -|None|[360 Frontend Static Resource Library](https://cdn.baomitu.com/)| |
70 | | -||[ByteDance Static Resource CDN](https://cdn.bytedance.com/)| |
71 | | -||[Chinese Font Network Project](https://chinese-font.netlify.app)| |
| 80 | +|-|[360 Frontend CDN](https://cdn.baomitu.com/)| |
| 81 | +||[ByteDance Static CDN](https://cdn.bytedance.com/)| |
| 82 | +||[Chinese Web Font Project](https://chinese-font.netlify.app)| |
72 | 83 |
|
73 | | -## Stargazers over time |
| 84 | +## Stars |
74 | 85 |
|
75 | 86 | [](https://starchart.cc/PJ-568/MARKDOWN.HTML) |
0 commit comments