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