Walrus decentralized storage system 使用教程

Walrus decentralized storage system 使用教程

walrus-docs Original repository holding documentation and examples for the Walrus decentralized storage system. 项目地址: https://gitcode.com/gh_mirrors/wa/walrus-docs

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

Walrus 是一个专为大型二进制文件或“blob”设计的去中心化存储和可用性协议。项目的目录结构如下：

• .github/: 存放 GitHub 相关的配置文件。
• .vscode/: Visual Studio Code 的配置文件。
• contracts/: 智能合约相关代码。
• docs/: 项目文档的源文件，使用 mdBook 工具生成。
• examples/: 存放使用 Walrus 的示例代码。
• po/: 包含翻译文件的目录。
• theme/: mdBook 使用的主题文件。
• CODE_OF_CONDUCT.md: 项目行为准则。
• LICENSE: 项目使用的 Apache-2.0 许可证。
• README.md: 项目描述文件。
• TRANSLATING.md: 提供如何创建和维护翻译的指导。
• _typos.toml: 拼写检查配置文件。
• book.toml: mdBook 的配置文件。
• mdbook-admonish.css: mdBook 的警告样式表。
• 其他配置文件如 .editorconfig, .gitignore, 等等。

2. 项目的启动文件介绍

项目的启动主要是通过 docs/ 目录下的文件来完成的。以下是几个关键的启动文件：

• README.md: 是项目的根目录下的描述文件，它提供了项目的概述以及如何使用和贡献项目的指导。
• book.toml: 这是 mdBook 的配置文件，它定义了文档的标题、作者和其他元数据，以及书籍的结构。
• mdbook serve: 这条命令用于启动本地服务器，以便在浏览器中预览文档。

在使用前，需要确保安装了 Rust 和 mdBook 相关工具，然后通过以下命令构建文档：

cargo install mdbook
cargo install mdbook-admonish@1.18.0 --locked
cargo install mdbook-katex@0.9.0 --locked
cargo install mdbook-i18n-helpers --locked
mdbook serve

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• .editorconfig: 用于定义代码编辑器的配置，以保持代码风格的一致性。
• .gitignore: 指定 Git 忽略的文件和目录，以避免将不必要的文件提交到版本控制。
• book.toml: 如前所述，这是 mdBook 的配置文件，它定义了文档的布局和元数据。
• mdbook-admonish.css: 自定义的 CSS 文件，用于定义警告框的样式。

确保正确配置这些文件，可以帮助维护项目的一致性和结构。在使用 Walrus 时，可能还需要根据具体需求调整配置文件以适应不同的使用场景。

walrus-docs Original repository holding documentation and examples for the Walrus decentralized storage system. 项目地址: https://gitcode.com/gh_mirrors/wa/walrus-docs