量子集文档
此回购包含Quantum Set Dollar(QSD)项目的文档。
概括
该仓库使用Nextra生成器从一系列markdown文件创建一个文档网站。这些文件遵循文件树结构来分割节并保持存储库可维护。
档案结构
应用以下树结构:
├── home.md // Top level content
├── meta.json // Top level menu info
├── protocol
Ecosoft MKDocs文档模板
什么是MKDocs?
该文档模板基于具有PDF导出扩展名
基于.md格式,可以生成漂亮的文档网站和PDF。
要了解mkdocs的工作方式,只需执行几行代码(在Linux中)即可。
$ pip3 install mkdocs # Install the package
$ cd ~ # Go to home directory
$ mkdocs new my-doc-
grow.dev
的文档网站。
开发人员设置
该项目使用静态网站生成器 。
先决条件
至少,您将需要:
设置Pipenv和Node后,使用以下命令安装项目。 这将安装正确版本的Python,也将安装Grow。
安装,别名并运行
# Run from the project directory.
pipenv install
# Add an alias to `$HOME/.bashrc` for grow.
alias grow= ' pipenv run grow '
# Install