starknet docs
v0.1.514
Starknet Docs网站https://docs.starknet.io是在ASCIIDOC编写的，是使用Antora构建的，Antora是Asciidoc的静态网站生成器。
如果您有兴趣为Starknet技术文档做出贡献，下表提供了快速链接以帮助您开始。
问题 | 资源 |
我有兴趣，该如何贡献？ | 有关如何贡献的信息，请查看不同的贡献方式。 |
有什么基本准则可以帮助我吗？ | 有关帮助我们保持内容一致的基本准则，请参见文档指南。 |
我应该使用的样式指南和写作指南吗？ | 请参阅《 Starknet文档补充样式指南》。 |
我如何设置工作站？ | 请参阅设置您的环境。 |
您可以通过几种方式为Starknet文档做出贡献：
创建一个GitHub问题。
提交拉动请求（PR）。您可以创建自己的starknet-docs存储库的本地克隆，进行更改并提交PR。如果您有实质性更改，或者帮助您更快地添加的更改，则此选项是最好的。
提交公关时会发生什么？
当您提交PR时，Starknet Docs团队会审查PR，并根据需要安排进一步的技术审查。如果PR需要更改，审阅者将向PR添加评论。我们可能会要求您进行更改，或者让您知道我们将您的内容纳入了其他PR。有时，我们可能会直接将其添加到原始PR。审查PR并完成所有更新时，文档团队将合并PR并将其应用于有效版本。
Starknet文档补充风格指南：一般风格指导和写作指南。
有关在Asciidoc写作的信息，请参见：
ASCIIDOC语言文档
Asciidoc语法快速参考
笔记 | 编码ID，源代码块，交叉引用和链接有多种方法。通常，我们使用最明确的编码约定进行编码，以优先考虑代码可读性。这些编码惯例大多数都在Asciidoc标记中列出了红帽文档的快速参考 |
如果尚未安装yarn ，请安装纱线。
如果尚未安装npx ，则安装它。
克隆此仓库，无论是从叉子上，还是您是官方合作者，然后直接从starknet-io/starknet-docs 。
更改为starknet-docs目录。
运行yarn命令以准备环境：
纱
yarn应通过安装基于package-lock.json和package.json所需模块来准备您的环境。如果成功，您应该能够构建和预览内容。
写作或编辑内容后，预览您的更改：
通过运行build_local_site.sh构建内容构建内容：
./build_local_site.sh此命令在目录public_html中生成网站。
通过以下一项开放网站：
打开开始页面： <repo_root>/public_html/index.html 。
运行使用Antora打包的HTTP服务器：
npx http-server public_html -c-1该服务器运行，并为您提供一个或多个可用于查看网站的本地URL。例如：
Starting up http-server, serving public_html
...
Available on:
http://127.0.0.1:8080
http://192.168.68.111:8080
http://192.168.14.3:8080
http://10.14.0.2:8080
Hit CTRL-C to stop the server发布文档的高级流程在此存储库中更改。
在内容开发过程中，作者将分支机分支合并为直接变化为main分支，这些更改等到我们准备释放它们，也就是说，将它们发布到docs.starknet.io。
GitHub操作创建了git标签和发行版，这些版本出现在回购版本和标签页面上。
当功能分支合并到main分支中时，github操作将在格式v<version>.<major_update>.<minor_update>中创建CHANGELOG.md标签。然后，它将新内容发布到docs.starknet.io。
合并功能分支以main发布功能分支中的更改。无需其他步骤。
github在package.json和package-lock.json中递增版本号，并更新CHANGELOG.md ，并使用刚刚合并为main的每个PR的描述。 。使用以下一个从远程main分支更新您的本地main分支：
拉更改：
starknet-docs (main) git pull从[email protected]:starknet-io/starknet-docs.git ：
starknet-docs (main) git fetch origin
starknet-docs (main) git rebase origin/main笔记 | 如果您使用的是叉子，则您的叉子仓库默认为 |
