Contributing Guidelines

随时欢迎任何人提交Pull Request，或者在GitHub上提交Issue。 科研仔在科研过程中遇到的问题也可以提在Issue里，对于有价值的提问，我们会整理归纳成文档。

项目文件目录：

.
├── docs # 文档目录
├── Makefile
├── mkdocs.yml # 配置文件，定义了文档的总体目录、远程库位置和视觉主题
├── README.md # 项目介绍
└── requirements.txt # 用于安装依赖的Python包

下载此库至本地，并进入目录:

git clone https://github.com/kyzjnbk/kyzjnbk
cd kyzjnbk

环境配置(需要python 3.x)：

pip3 install -r ./requirements.txt

在本地实时预览(默认8000端口)：

mkdocs serve

基本排版

• Markdown Reference
• Material for MkDocs - Reference

多媒体

图片

图片Markdown源码说明

![](contributing.asserts/avril.png)

![](path_to_image)

Youtube视频

Youtube视频Markdown源码说明

![type:video](https://www.youtube.com/embed/8xg3vE8Ie_E)

![type:video](https://www.youtube.com/embed/video_id)

BiliBili视频

BiliBili视频HTML源码说明

<iframe src="//player.bilibili.com/player.html?aid=60825989&bvid=BV1kt411A7mK&cid=105846665&page=1"
    scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true"
    style="width: 100%; height: 500px; max-width: 100%；align:center; padding:20px 0;"
> </iframe>

复制嵌入代码后加上

style="width: 100%; height: 500px; max-width: 100%；align:center; padding:20px 0;"

Jupyter Notebook

Google Colab

Google ColabMarkdownHTML说明

The markdown for the badge is the following:

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/googlecolab/colabtools/blob/master/notebooks/colab-github-demo.ipynb)

The HTML equivalent is:

<a href="https://colab.research.google.com/github/googlecolab/colabtools/blob/master/notebooks/colab-github-demo.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>

图标URL：

https://colab.research.google.com/assets/colab-badge.svg

链接格式：

https://colab.research.google.com/github/ORGNAZATION_NAME/REPO_NAME/blob/BRANCH_NAME/PATH_TO_NOTEBOOK

---

最后更新: April 21, 2022