iota wiki

探索Wiki

報告錯誤·請求主題

目錄

• 關於項目
  • 建立
• 入門
  • 先決條件
  • 地方發展
• 貢獻
• 接觸

關於項目

Iota Wiki是進入IOTA生態系統的中心樞紐。一項由社區驅動的倡議，旨在提供最新的介紹集，並進一步閱讀有關技術，團隊，社區以及介於兩者之間的所有內容。因此，任何人都可以學習如何在一個空間中建立，採用和與IOTA互動。

建立

IOTA Wiki是使用Typescript，ReactJS和Docusaurus v2.0構建的。

入門

先決條件

• git 1.8.2或更高。
• Node.js 16.10或更高。
• 通過運行corepack enable啟用啟用現代紗線。

本地預覽

要在本地預覽Wiki，請使用以下步驟。有關更詳細的腳本，請參見預配置的腳本以獲取參考。

請注意，Wiki有很多內容，因此目前最初的構建需要一段時間。努力嘗試減少未來的構建時間。

1. 通過運行git clone https://github.com/iotaledger/iota-wiki.git來克隆存儲庫，然後使用cd iota-wiki轉到目錄。
2. 使用yarn安裝依賴項。
3. 通過運行yarn prepare來準備環境，這只能完成一次。
4. 隨著yarn start ，預覽Wiki，這將啟動一台具有熱重載功能為Wiki服務的開發服務器，因此進行了任何更改後，它將更新內容。

預先配置的腳本

腳本	解釋
prepare	通過檢查子模型構建來準備環境。
start	啟動為Wiki服務的開發服務器，並在更改上進行熱重新加載。
start:section:{section}	啟動僅服務Wiki部分的開發服務器，並進行更改的熱重新加載。可用的部分是build ， get-started ， learn和maintain 。
build	構建Wiki。要構建生產，請通過運行yarn checkout:remote並將MODE環境變量設置為production 。
checkout:remote	查看最新版本的外部文檔。
generate:api	生成通過Docusaurus OpenAPI插件配置的可用API文檔，並通過從源代碼中編譯文檔。

貢獻

iota Wiki始終受到IF和社區貢獻的維持。 IF的DX團隊及相關團隊將審查所有問題，並提取發佈到此存儲庫的請求。如果您發現任何錯誤或覺得缺少某些錯誤，請隨時創建一個與團隊討論的問題，或直接創建帶有建議的拉動請求。這是打開拉請請求的基本工作流程：

1. 將此存儲庫分配給您自己的帳戶並克隆它（ git clone https://github.com/<YOUR_USERNAME>/iota-wiki.git ）
2. 為您的更改創建功能分支（ git checkout -b feat/amazing-feature ）。
3. 進行更改，並可選地在本地預覽它們。
4. 運行yarn format和yarn lint ，並修復任何剩餘的錯誤和警告。
5. 提交您的更改（ git commit -m 'Add some amazing feature' ）。
6. 將您的更改推向叉子（ git push origin feat/amazing-feature ）。
7. 向此存儲庫的main分支打開拉動請求。

看看有助於進一步指導的貢獻。

版本控制

要了解如何版本的文檔，請閱讀本指南。

在線單擊設置用於貢獻

您可以使用GitPod（免費的在線，類似代碼的IDE）來貢獻。單擊一鍵，它將準備您構建並為Wiki做出貢獻所需的一切。只需單擊此按鈕，然後從上方跳過步驟1。

接觸

phylo -Phyloiota -Phylo [社區DAO-放手！ ]＃2233
Jeroen van den Hout -Jlvandenhout -JVDHout＃4402
電子博士-DR -Electron -Dr.Electron＃9370
批判-Kilianhln-關鍵＃7111
JSTO -JSTO91 -JSTO＃3746