# 改进文档
Handlebars 是一个开源项目。没有专门的“文档部门”来维护文档的最新状态。这个文档网站需要你的帮助才能成为一个良好且有用的网站。
发布说明 (opens new window)
带有“docs-needed”标签的问题 (opens new window)
旧的 Handlebars 网站 (opens new window)
以下部分将帮助你帮助我们改进文档。
# 如何提交贡献?
此网站托管在 Github (opens new window) 上,并使用 VuePress (opens new window) 渲染。
- 请为你想在页面上看到的任何更改创建 拉取请求 (opens new window)。
- 如果你的更改只影响单个页面的内容,你只需点击此页面底部的链接“建议对此页面进行更改!”(有关详细信息,请参阅 编辑其他用户存储库中的文件 (opens new window))。
- 对于更复杂的更改(样式、多个页面、新页面、修复构建问题),你应该 派生存储库 (opens new window),并在完成时提交拉取请求。存储库中的 CONTRIBUTING.md 页面 (opens new window) 包含更多信息。这种方法允许你在提交更改之前使用开发服务器并预览更改。
# 如何编写内容?
文档是用 Markdown 编写的,并使用 VuePress (opens new window) 渲染。VuePress 使用 markdown-it
包来渲染 Markdown。markdown-it
实现了 CommonMark 方言。
这意味着你可以使用这些来源中描述的语法
- CommonMark 帮助 (opens new window)
- markdown-it 添加的语法扩展 (opens new window)
- VuePress 添加的语法扩展 (opens new window)
除了所有这些扩展之外,此网站还添加了一些自定义 Vue 组件,可以嵌入源文件中。
# 我应该如何表现?
危险
尊重知识产权:请仅在你自己创建文本和其他媒体或从 handlebarsjs.com (opens new window) 复制时提交。有很多关于 Handlebars 的博客文章,但这些文章中的文本是其作者的知识产权。
许可证:通过提交内容,你同意它在此网站的许可证下在此网站上发布。
行为准则:请尊重他人,避免使用性暗示或粗俗的语言。
# 我能贡献什么?
- 查找标记为 docs-needed (opens new window) 的问题,在 handlebars.js (opens new window) 存储库中。 这些是描述应该记录的内容的问题。
- 提出并提交新内容。 如果你不确定你的提议,你可以在提交拉取请求之前创建一个问题。这可能会节省你的时间。
- 改进现有内容。 你可以建议更改导航、修复错别字、改进语言和更正错误内容。
- 修复 CSS 样式问题。 此页面的样式远非完美。如果你想改进它,请继续。对于较大的更改,请通过打开问题与我们联系。
创建交互式示例 →