跳到主要内容

示例教程结构

简介​

简介的标题 必须 为 H2: ## 简介

这一部分是用来解释这个教程的背景和重要性，我们将在本教程中构建和学习什么。

  • 像你对五岁小孩解释一样来阐述这一部分 (ELI5)
  • 用最多5-6行来解释这一切。

例如:

智能合约只是一个在TON区块链上运行的计算机程序，或者更具体地说，在其TVM（TON虚拟机）上运行。合约由代码（编译的TVM指令）和数据（持久状态）组成，这些都存储在TON上的某个地址。

必要条件​

必要条件标题 必须 为 H2: ## 必要条件

这一部分是用来解释开始本教程前任何需要预先掌握的知识或需要先完成的教程。如果需要任何的代币—要在这里提及。

例如:

在这个教程中，我们将在测试网上铸造Jetton。在我们继续之前，请确保你的测试网钱包有足够的余额。

要求​

要求标题 必须 为 H2: ## 要求

可选 : 如果你的教程有任何视频内容，请在这一部分嵌入。

在开始教程之前需要安装的任何技术程序，以及本教程不会涉及的内容（TON钱包扩展、node等）。请不要将要安装的程序包在教程中列出。

例如:

  • 我们需要在本教程中使用TON钱包扩展；可以从这里安装。
  • 确保已安装NodeJS 12.0.1+。

教程正文​

  • 请不要使用“教程正文”作为标题，请使用与材料相关的自己的标题。
    • 如果你想不出别的，使用“开始”也是可以接受的😉
  • 添加文本内容来引导读者通过你的教程，并记得在提交教程之前校对内容，以避免拼写和语法错误。
    • Grammarly是一个可以帮助你避免语法错误的免费程序。

关键点​

  • 不要使用“教程正文”作为标题！

  • 保持所有子标题在H3，不要使用H4或更低。

    • 在Markdown语法中，两个井号用于H2标题: ##
    • 三个井号用于H3标题: ###

  • 只在代码块中添加必要的注释。不要在终端输入代码块中添加#样式的注释。

  • 添加所有相关的代码块：

    • Markdown语法的代码块由代码块开始和结束时的三个反引号组成。同时，请确保在所有代码块的反引号前后都有一个新行。例如：
      • ```js
        const testVariable = 'some string';
        someFunctionCall();
        ```
    • 所有代码块必须有语法高亮类型。如果不确定，使用```text。
    • ```text用于终端输出、终端命令和纯文本。
    • ```javascript 或 ```js可用于任何JavaScript代码。
    • ```typescript或```ts可用于任何TypeScript代码。
    • ```jsx用于ReactJS代码。
    • ```cpp用于Func代码。
    • 使用```graphql突出显示GraphQL语法。
    • 使用```json突出显示有效的JSON。（对于无效的JSON示例，请使用```text。）
    • ```bash应仅用于需要#样式注释的代码块。这必须小心进行，因为在许多情况下，#字符将呈现为markdown标题。如果发生这种情况，通常目录会受到影响。

  • 不要使用预格式化文本来强调；而是只使用粗体或斜体文本。

  • 添加图片或代码块以反映预期的终端输出。

  • 采取错误驱动的方法来编写你的教程。添加常见错误和故障排除步骤。例如:

由于执行node deploy:testnet命令时出错，无法连接到Testnet。

让我们看看一些常见原因：

  • 确保你在.env中生成的测试网钱包有足够的资金。如果没有，请从水龙头赠送处添加一些测试网代币。
  • 如果你仍然遇到同样的问题，请向Dev Chat中的开发者求助。

结论​

结论标题 必须 为 H2: ## 结论

这一部分应总结在教程中学到的内容，强调关键点，并祝贺学习者完成教程。使用最多5-6行。 例如:

我们创建了一个具有计数功能的简单新FunC合约。然后我们在链上构建并部署它，最后通过调用getter和发送消息与它进行交互。

请记住，这段代码不适用于生产；如果你想将其部署到主网，还有一些其他事项需要考虑，例如，如果代币在市场上挂牌，就禁用转移的方法等等。

参阅​

下一步标题 必须 为 H2: ## 参阅

使用这一部分来解释完成本教程后接下来可以做什么以继续学习。可以添加与本教程相关的推荐项目和文章。如果你正在进行任何其他高级教程，可以在这里简要提及。通常，只有来自docs.ton.org的相关页面会放在这里。

关于作者 (可选)​

关于作者标题 必须 是 H2: ## 关于作者

保持简短。最多一两行。你可以包括你的GitHub个人资料链接+ Telegram个人资料。请避免在这里添加你的LinkedIn或Twitter。

参考资料 (可选)​

参考资料标题 必须 是 H2: ## 参考资料

如果你在编写本教程时从其他文档、GitHub库或现有教程中获得了任何帮助，则必须 有这一部分。

通过添加它们的名称和文档链接来致敬来源。

如果不是数字文档，请添加ISBN或其他形式的参考。