跳转至

参与撰写

本用户文档已开源，欢迎参与撰写。文档维护在开源中国的 GIT 仓库服务中，如希望参与撰写或帮助改进文档，请访问位于开源中国的 龙宫STC用户文档 项目。您也可以直接发送邮件到 public@loongcad.com 来寻求支持。

如何参与撰写

访问文档代码

  • 该文档采用 Markdown 语法撰写，使用 Git 工具管理所有代码和多媒体资源。
  • 您可以访问 龙宫STC用户文档 项目以查看文档的所有代码。
  • 通过 轻量级PR 或者 Fork+PR 两种方式，您可以将自己的改动或新文章添加到项目中。
  • 点击本文中的链接，您可以获取更多帮助。

Fork+PR

  • Fork+PR 是开源项目常用的方式。
  • 采用这种方式，您需要首先 fork 整个代码库到自己的空间中，完成修改后提交 Pull Request，等待管理员完成审批后，您的改动将会被合入官方文档。
  • 该方法适合大量文件的修改，或新加若干新文件。

轻量级PR

  • 轻量级PR 是开源中国提供的一种更加轻量且便捷的方式。
  • 您需无需 fork 整个代码库，只需通过网页编辑您要修改的内容，然后直接完成在线提交以及 Pull Request ，等待管理员完成审批后，您的改动将会被合入官方文档。
  • 该方法适合少量的修改。

文档代码的目录结构

  • 文档代码库中主要内容包含在根目录下的 /docs 目录中，docs 目录包含 custom / docs / site 目录，以及 mkdocs 的配置文件。
  • /docs/custom 目录包含了网页中所需的图片、视频、css等资源，mkdocs 在生成网页时会自动拷贝该目录到 site 目录中。
  • /docs/docs 目录包含了所有 markdown 语法的文档内容，您的修改将主要在这个目录中。
  • /docs/site 目录为最新版本文档所生成的网页。

预览文档

  • 本文档采用 Markdown 语法撰写，并使用 mkdos 工具将 Markdown 文档转换为网页。
  • 如果您希望在本地环境中预览网页文档的最终效果，可以参考以下步骤搭建预览环境。
# Mkdos 由 Python 脚本编写和执行。
# 需要先在本机安装 Python 环境以及 pip 工具，建议从官网安装最新版本。
# 完成 Python 和 Pip 安装后，需要安装下列 Mkdocs 和本文档所依赖的模块。
# 打开 Windows powershell，输入以下命令：

pip install mkdocs
pip install pymdown-extensions
pip install markdown-include
pip install markdown-callouts
pip install mkdocs-callouts
pip install mdx-gh-links
pip install mkdocs-click
pip install mkdocs-redirects
pip install mkdocs-autorefs
pip install mkdocs-literate-nav
pip install mkdocstrings
pip install mkdocstrings-python
pip install jieba
pip install mkdocs-material
pip install mkdocs-mermaid2-plugin
pip install mknotebooks
pip install mkdocs-macros-plugin
pip install mkdocs-git-revision-date-plugin
pip install mkdocs-glightbox
pip install mkdocs-video

# 成功完成所有模块的安装后，切换到项目的 docs 目录下，执行下列命令以在本机开启文档预览服务：

mkdocs.exe build
mkdocs serve -a 0.0.0.0:8000

# 服务启动后，在浏览器地址栏输入 http://127.0.0.1:8000，即可预览本文档。

参考资料

GIT 参考

Mkdocs