该存储库包含一个演示手稿,目的是使用Manubot练习的每个人。
要编辑手稿,请更改content目录中的文件。您可以使用铅笔图标使用GitHub Web界面编辑文件,如“入门视频”中所示。另外,如果您有Git和github的经验,则可以分配此存储库并提出传统的拉力请求。
Manubot是通过Github编写学术手稿的系统。 Manubot使用Git自动引用和参考,版本手稿,并通过GitHub启用协作写作。概述手稿介绍了与Manubot及其独特功能的协作写作的好处。 rootstock存储库是用于创建新的manubot实例的通用模板,如SETUP.md中所述。有关文档如何编写手稿,请参见USAGE.md 。
请为与Manubot使用,错误报告或一般查询有关的问题打开一个问题。
目录如下:
content包含手稿源,其中包括标记文件以及引用和参考的输入。有关更多信息,请参见USAGE.md 。output包含来自Manubot的输出(生成的文件),包括所得的手稿。您不应该手动编辑这些文件,因为它们会被覆盖。webpage是一个目录,旨在作为查看HTML手稿的静态网页。build包含构建手稿的命令和工具。ci包含通过连续集成部署所需的文件。运行manubot的最简单方法是在内容更改时使用连续集成来重建手稿。如果您想在本地构建Manubot手稿,请按照build中所述安装Conda环境。然后,您可以通过从此根目录中运行以下命令来构建POSIX系统上的手稿。
# Activate the manubot conda environment (assumes conda version >= 4.4)
conda activate manubot
# Build the manuscript, saving outputs to the output directory
bash build/build.sh
# At this point, the HTML & PDF outputs will have been created. The remaining
# commands are for serving the webpage to view the HTML manuscript locally.
# This is required to view local images in the HTML output.
# Configure the webpage directory
manubot webpage
# You can now open the manuscript webpage/index.html in a web browser.
# Alternatively, open a local webserver at http://localhost:8000/ with the
# following commands.
cd webpage
python -m http.server有时,监视内容目录并在检测到更改时自动重建手稿是有帮助的。在运行时,以下命令将在内容更改时触发build.sh脚本和manubot webpage命令:
bash build/autobuild.sh每当打开拉动请求时,CI(连续集成)将测试更改是否打破了生成格式手稿的构建过程。构建过程旨在检测常见错误,例如无效的引用。如果您的拉动请求构建失败,请参见CI日志以获取故障原因,并相应地修改您的拉力请求。
当发生对main分支的提交(例如,当合并拉动请求时)时,CI构建手稿并将结果写入gh-pages和output分支。 gh-pages分支使用github页面托管以下URL:
有关连续的集成配置详细信息,请参见.github/workflows/manubot.yaml 。
除非另有说明,否则该存储库的整个库是根据CC by 4.0许可( LICENSE.md )许可的,该许可允许使用归因。请通过链接到https://github.com/manubot/try-manubot来归因。
由于CC的代码和数据不是理想的选择,因此在CC0 1.0公共领域奉献( LICENSE-CC0.md )下也发布了某些存储库组件。所有与以下全球模式匹配的文件均在CC下双重许可,由4.0和CC0 1.0:
*.sh*.py*.yml / *.yaml*.json*.bib*.tsv.gitignore所有其他文件仅在CC By 4.0下可用,包括:
*.md*.html*.pdf*.docx请为与许可有关的任何问题打开一个问题。