构建jsPsych文档

托管于https://www.jspsych.org使用mkdocs生成，并使用mkdocs-material theme。文档相关文件位于GitHub仓库的/docs文件夹下，使用markdown编写。

如果要在本地构建文档，则需要使用poetry安装mkdocs、mkdocs-material和mike。

安装poetry

Poetry是python的一个包管理器，你可以参照poetry官网的安装教程把它运行起来。

安装开发依赖

在jsPsych根目录运行poetry install来安装mkdocs、mkdocs-material以及其他依赖项。

本地构建文档

如果要构建最新版本的文档，或者是覆盖已有的版本，请运行poetry run mike deploy [version] -u。例如，如果你想要构建文档的7.2版本，就可以运行poetry run mike deploy 7.2 -u。

你还可以使用jsPsych自带的npm命令：npm run docs:deploy [version]，例如npm run docs:deploy 7.2。

此时，生成的文档会被自动提交到gh-pages分支。

我们在构建阶段没有使用mkdocs命令，而是使用了mike，因为后者才支持文档的版本控制。不过实际上mike底层运行的还是mkdocs命令。

查看本地文档

如果要运行一个本地的服务器，可以运行poetry run mike serve命令或者是使用jsPsych自带的npm命令：npm run docs:serve。

此时，可以在http://localhost:8000查看文档。

更新公开文档站点

警告

仅限核心开发者

在完成文档的本地构建后（即，已经提交到了本地的gh-pages分支后），就可以将其推送到远程的gh-pages分支以更新文档所在的站点。