Skip to content

共同参与

Jump to bottom
0xdwong edited this page Jun 16, 2023 · 7 revisions

添加教程

你可以 fork 本项目，从头开始编写教程(使用 Docusaurus 框架)。你也可以提交已有的文档(Docusaurus, gitbook)。

编写教程

  1. fork 本项目

  2. 编写教程文档

    本项目使用 Docusaurus 生成文档，因此需要遵循其约定

  3. 本地测试

    编写完成后，可以在本地启动，预览效果

    npm i
npm run start

  4. 在 Issue 提交文档对象(Github 项目地址、文档名等)

提交现有教程

目前支持 Docusaurus 框架生成的文档，以及 gitbook 文档(要求已同步到 Github)

  1. 在 Issue 提交文档对象(Github 项目地址、文档名等)

文档对象

示例：

    {
        "repoUrl": "https://github.com/decert-me/blockchain-basic",
        "label": "区块链基础",
        "startPage": "start",
        "catalogueName": "blockchain-basic",
        "img": "https://ipfs.decert.me/images/blockchain-basic.png",
        "desc": "区块链是一项令人兴奋且在快速发展的技术，你也许看到过这些频繁在社交媒体、新闻频道上冒出的新名词：智能合约、代币（通证）、Web3、DeFi、DAO 组织。 如果你还不是很明白他们的意思，这份免费区块链基础教程就是为你（小白们）准备的。",
        "docType": "docusaurus"
    },

字段解释:

字段名 值类型 备注
repoUrl String Github 项目地址
label String 教程标题
startPage String 起始页
catalogueName String url path
img String 封面图片
desc String 教程描述
docType String 文档生成器类型: docusaurus, gitbook
Clone this wiki locally