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筆記 | 如果您使用的是叉子，則您的叉子倉庫默認為 |
