1. Markdown 格式:
- 使用 Markdown 格式编写文档,这是 Electron 文档的首选格式。Markdown 提供了轻量级的标记语法,易于编辑和阅读。
2. 代码块:
- 使用三个反引号(\\\)包裹代码块,并指定语言(例如 javascript、bash)以进行正确的语法高亮。
const electron = require('electron');
3. 文件和目录命名:
- 对于文件和目录,使用小写字母和短划线(kebab-case)的组合。例如,main-process-windows.md。
4. 标题风格:
- 使用 # 标记表示标题,标题后面应该跟随一个空格。
# 主进程 (Main Process)
5. 链接和引用:
- 对于链接,使用 [text](url) 的语法。对于引用链接,定义一个链接引用,以便在文档中多次使用。
[Electron 官方网站](https://www.electronjs.org/)
引用链接:
[Electron 文档][electron-docs]
...
[electron-docs]: https://www.electronjs.org/docs
6. 列表:
- 对于有序列表,使用数字后跟一个点号。对于无序列表,使用星号、加号或减号。
1. 第一项
2. 第二项
- 无序项
- 另一项
7. 强调和粗体:
- 使用单个星号或下划线表示斜体,使用两个星号或下划线表示粗体。
*斜体* 或者 _斜体_
**粗体** 或者 __粗体__
8. 图像:
- 对于图像,使用 ![alt text](url) 的语法。确保提供了替代文本,以确保图像无法显示时也能够传达信息。
![Electron Logo](images/electron-logo.png)
9. 引用块:
- 使用 > 表示引用块。可以嵌套使用多个 > 表示多层引用。
> 这是一个引用块
>> 这是嵌套的引用块
10. 注意事项和警告:
- 使用 > NOTE: 表示注意事项,使用 > WARNING: 表示警告。确保这些内容在文档中引起注意。
> **NOTE:** 这是一条注意事项。
>
> **WARNING:** 这是一条警告。
这些是一些建议的 Electron 文档风格指南。在编写文档时,确保遵循一致的格式和约定,以提高文档的质量和可读性。同时,建议查阅 Electron 官方文档以获取更详细的文档风格指南。
转载请注明出处:http://www.zyzy.cn/article/detail/10952/Electron