https://github.com/probiusofficial/documentwritememo
中文文档写作备忘录 (Markdown based)
https://github.com/probiusofficial/documentwritememo
Last synced: 4 months ago
JSON representation
中文文档写作备忘录 (Markdown based)
- Host: GitHub
- URL: https://github.com/probiusofficial/documentwritememo
- Owner: ProbiusOfficial
- License: other
- Created: 2023-12-18T12:09:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-18T15:30:15.000Z (over 2 years ago)
- Last Synced: 2025-02-26T07:43:26.358Z (over 1 year ago)
- Size: 2.93 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# documentWriteMemo
中文文档写作备忘录 (Markdown based)
## 写作规范
写作规范使用 https://github.com/ruanyf/document-style-guide
[标题](https://github.com/ruanyf/document-style-guide/blob/master/docs/title.md)
[文本](https://github.com/ruanyf/document-style-guide/blob/master/docs/text.md)
[段落](https://github.com/ruanyf/document-style-guide/blob/master/docs/paragraph.md)
[数值](https://github.com/ruanyf/document-style-guide/blob/master/docs/number.md)
[标点符号](https://github.com/ruanyf/document-style-guide/blob/master/docs/marks.md)
[文档体系](https://github.com/ruanyf/document-style-guide/blob/master/docs/structure.md)
[参考链接](https://github.com/ruanyf/document-style-guide/blob/master/docs/reference.md)
## 辅助性工具
写作工具: [Typora](https://github.com/typora)
Typora 写作辅助插件：https://github.com/obgnail/typora_plugin
终端命令演示：https://asciinema.org/
## 框架
mkdocs：https://github.com/mkdocs/mkdocs
\- mkdocs-material：https://github.com/squidfunk/mkdocs-material