|
4 | 4 |
|
5 | 5 | This project aims to provide a low-dependency, simple deployment solution for rendering Markdown web pages. |
6 | 6 |
|
7 | | -## Features |
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. |
16 | | - |
17 | | -## Usage |
18 | | - |
19 | | -### Manual Deployment |
20 | | - |
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`. |
23 | | - |
24 | | -### Github Actions |
25 | | - |
26 | | -```yaml |
27 | | -- name: Deploy markdown.html |
28 | | - uses: PJ-568/MARKDOWN.HTML@v<version> |
29 | | - with: |
30 | | - target-dir: '.' |
31 | | - file-name: 'index.html' |
32 | | -``` |
33 | | -
|
34 | | -## Additional Notes |
35 | | -
|
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). |
37 | | - |
38 | | -## Code or Content Contributions |
39 | | - |
40 | | -We welcome contributions of code and content from anyone interested in this project. |
41 | | -Please checkout [程序逻辑](doc/logic.md). |
42 | | - |
43 | | -For a simpler way to contribute, please refer to the [Contribution Guide](CONTRIBUTING.md) for relevant information. |
44 | | - |
45 | | -## License |
46 | | - |
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. |
48 | | - |
49 | | -### Credits |
50 | | - |
51 | | -#### Projects |
52 | | - |
53 | | -|Name|License|URL| |
54 | | -|:-:|:--|:--| |
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)| |
61 | | -|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)| |
64 | | - |
65 | | -#### Services |
66 | | - |
67 | | -|Icon|Name| |
68 | | -|:-:|:--| |
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)| |
72 | | - |
73 | | -## Stargazers over time |
74 | | - |
75 | | -[](https://starchart.cc/PJ-568/MARKDOWN.HTML) |
| 7 | +<!-- TODO --> |
0 commit comments