for script or mod.

将main-pages仓库克隆到本地后，cd到根目录执行以下命令：

% pip install mkdocs %
pip install mkdocs-material
pip install mkdocs-blogging-plugin
pip install git+https://github.com/fmaida/hello-dolly-mkdocs-plugin
pip install git+https://github.com/srymh/MkdocsTagPlugin
pip install mkdocs-git-revision-date-plugin
pip install mkdocs-git-authors-plugin
pip install mkdocs-rss-plugin
pip install mkdocs-print-site-plugin
pip install mkdocs-tooltips
pip install mkdocs-categories-plugin
pip install mkdocs-git-show-history-log-plugin
mkdocs serve

控制台将会返回本地预览窗口。

如果你是Dice!脚本作者，那么你可以fork plugin仓库，然后按格式提交PR。

注意，请按照格式和规范提交pr:

1. 若您提交的是单个*.lua文件，请在脚本前四行务必写上如下注释，否则审核将会被打回：

   -------------------------------
   -- @脚本名 by 你的名字或联系方式
   -- @license 协议名(比如MIT.)
   -------------------------------

   这么做的理由是为了让您的脚本在被他人下载使用时，让他人知晓作者是谁，(若有报错)如何联系，能否二次演绎(协议)。

   随后请将你的lua脚本提交至Single File文件夹，并在该文件夹下的README.md内找到当天日期（如没有就添加一个）写上:

   日期:
      - 脚本文件（包含.lua扩展名） by 作者名（联系方式)
   #比如:
   2022年10月30日:
      - DailyNews.lua by 简律纯
      - xxx.lua by xxx

2. 若您的脚本包含*.lua文件数量过多或是包含文件夹，请将它们全部放在一个以脚本名命名的文件夹内上传，并附上README.md简单介绍各个文件的作用以及一些作者信息。 它们将会是这样的:

   plugin_name
        |-README.md
        |-part1.lua
        |-part2.lua
        |————dir
              |-file1
              |-file2
   

   README.md文件内可以这样写：

   脚本名：plugin_name
   part1.lua:用于接受配置指令
   part2.lua:脚本主体
   dir:配置文件存放文件夹
   file1:配置文件1
   ...:...
   作者:xxx
   联系方式：[email protected]

   随后请将你的文件夹提交至Mutiple Files文件夹,并在该文件夹下的README.md内找到当天日期（如没有就添加一个）写上:

   日期:
      - 你上传的文件夹名称 by 作者名（联系方式)
   #比如:
   2022年10月30日:
      - team call by Pine
      - xxx by xxx

本段作者:梦夜雨
校对:简律纯

如果你是牌堆作者，那么你可以fork PublicDeck仓库，然后按格式提交PR。

=== ":octicons-file-16: 提交*.json文件"

  1. 请务必在牌堆内写上如下信息，否则审核将会打回您的文件，这么做的理由是为了让您的脚本在被他人下载使用时，让他人知晓作者是谁，(若有报错)如何联系等。
  ```json
  {
    "_author":[
        "名字+联系方式"
    ]
  }
  ```
  在牌堆中写明此内容后，下一步就是上传了（一个吐槽:基本就是一路绿下去 (什) )
  2. 点击上方的连接后，在文件列表的右上会有一个名为code的绿色按钮，点击其左侧的Add file按钮 ，在下拉菜单中选择Upload files按钮
  3. 进入新的界面后，第一种方法是将.json文件拖入中间的框中，第二种方法是选择中间的蓝色choose you files按钮 ，并在弹出的资源管理器窗口中选择您要上传的文件
  4. 上传完成后，点击底部的绿色Commit changes按钮
  5. 此时您自己的库已经更新，之后需要在界面中寻找Pull request按钮并点击
  6. 在Pull Requests中，点击右边的绿色New pull request按钮或是中下蓝色的create a pull requret按钮
  7. 在新界面中选择绿色的Create pull request按钮 ，请求将代码提交到ssJSKFJDJ的库中

功能模块。是“主营业务”。 功能模块的收集没有任何像plugin或PublickDeck那样的专门的库，这里只选择功能模块作者在main-pages的master分支的Module文件夹下提交功能模块远程下载json的方式来收录Module。在收到PR以及审核通过后，审核人员会将你的功能模块库fork到ssJSKFJDJ。

其一般步骤如下：

1. fork main-pages库。一切都是从这里开始的。
2. 提交你的包含"pkg"字段的功能模块json： 比如listen2me库提供的json是这样的：

   {
     "mod":"listen2me",
     "author":"简律纯",
     "ver":"1.1.8",
     "dice_build":612,
     "brief":"使用mml作曲",
     "pkg":"https://github.com/A2C29K9/listen2me/releases/download/v1.1.8/listen2me_v1.1.8.zip",
     "comment":"",
     "helpdoc":{
         "listen2me":"【listen2me[Windows]】\n使用mml语言进行作曲\nhttps://github.com/A2C29K9/listen2me"
     }
   }

   你可以直接访问来查看该json所在位置。 这里我们只需要填写"pkg"字段即可，"repo"字段如有请删除。

   tips:pkg填写的是把功能模块打包好后发布的地址，必须为直链，不一定要在github上!

3. 给你的功能模块库添加lua和dice-mod标签。
4. 按照格式提交PR。
5. 如有需要一并提交md格式的技术文档。

审核通过后你会在ssJSKFJDJ仓库下找到自己的功能模块库，每次更新功能模块时仅需提交新的pkg字段的json至Module文件夹下即可。最后，给bot安装时仅需要在./DiceQQ/conf/mod/source.list文件内添加一行写上https://ssjskfjdj.netlify.app/Module/，然后重载bot并发送命令.mod get 你提交的功能模块名即可完成下载。

tips:论坛写帖子的时候也可以告诉大家这样安装就行了哦，可以使用如下模板：

# 1. install

- Dice版本2.6.5beta12(624+)以上安装方法:

  1. 在 `./DiceQQ/conf/mod/source.list`文件内（没有mod文件夹和这文件就新建）输入 `https://ssjskfjdj.netlify.app/Module/`。
  2. 使用 `.system load`命令重载bot，这样做的目的是为了让步骤1里的远程地址生效。
  3. 对bot发送 `.mod get [功能模块名]`命令，等待安装。
  4. 回到第二步，这样做的目的是为了让mod被加载。
  5. Enjoy Your Self!

- Dice版本2.6.4b(612+)以上安装方法：

  1. 浏览器访问 `https://github.com/ssJSKFJDJ/功能模块名`并点击绿色按钮 `Code`下的 `Download Zip`按钮下载仓库压缩包。
  2. 解压压缩包，将里面的文件和文件夹全部丢进 `./DiceQQ/mod/`文件夹内。
  3. 使用 `.system load`命令重载。
  4. Enjoy Your Self!

to be...

  MIT License

Copyright (c) 2022 ssJSKFJDJ

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.