IOTA Wiki 项目教程

1. 项目的目录结构及介绍

IOTA Wiki 项目的目录结构如下：

.
├── .github
├── .gitignore
├── .gitmodules
├── .gitpod.yml
├── .prettierignore
├── .prettierrc.json
├── .yarnrc.yml
├── cli
├── config
├── docs
├── scripts
├── src
│   └── ...
├── static
├── tests
├── .eslintignore
├── .eslintrc.json
├── LICENSE
├── README.md
├── docusaurus.config.js
├── package.json
├── playwright.config.ts
├── tsconfig.json
├── vercel.json
└── yarn.lock

• .github：包含 GitHub 的工作流文件，用于自动化一些操作，如代码审查、CI/CD 等。
• .gitignore：指定 Git 忽略的文件和目录。
• .gitmodules：用于管理子模块。
• .gitpod.yml：为 Gitpod 提供配置信息，Gitpod 是一个在线的代码编辑器。
• .prettierignore 和 .prettierrc.json：Prettier 配置文件，用于代码格式化。
• .yarnrc.yml：Yarn 配置文件。
• cli：命令行工具相关文件。
• config：项目配置文件。
• docs：文档资源。
• scripts：项目脚本文件。
• src：源代码目录。
• static：静态文件目录。
• tests：测试代码目录。
• 其他文件：包括项目许可证、README、配置文件等。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 文件中的脚本完成的。

在 package.json 文件中，可以看到以下预配置的脚本：

{
  "scripts": {
    "start": "docusaurus start",
    "build": "docusaurus build",
    "serve": "docusaurus-serve",
    ...
  }
}

• start：启动开发服务器，用于本地预览 Wiki。
• build：构建项目，用于生成静态网站文件。
• serve：启动一个静态文件服务器，用于查看构建后的网站。

通常，启动项目只需要运行以下命令：

yarn start

这会启动开发服务器，并在浏览器中打开一个新标签页，显示 Wiki 内容。

3. 项目的配置文件介绍

项目的核心配置文件是 docusaurus.config.js。这个文件包含了 Docusaurus 框架的配置，如网站元数据、插件、路由等。

以下是一些基本配置的示例：

module.exports = {
  // 网站的基本信息
  title: 'IOTA Wiki',
  tagline: 'The central hub for IOTA ecosystem.',
  url: 'https://wiki.iota.org',
  baseUrl: '/',
  // ...
  // 插件配置
  plugins: [
    // ...
  ],
  // ...
  // 路由配置
  routes: {
    // ...
  },
  // ...
};

此外，还有 tsconfig.json 文件，它是 TypeScript 的配置文件，用于指定编译选项和包含/排除的文件。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    // ...
  },
  "include": ["src"],
  "exclude": ["node_modules"]
}

以上就是关于 IOTA Wiki 项目的目录结构、启动文件和配置文件的介绍。