try manubot
1.0.0
Этот репозиторий содержит демо -рукопись, предназначенную для игровой площадки для всех, чтобы практиковаться с использованием Manubot.
Чтобы редактировать рукопись, внесите изменения в файлы в каталоге content . Вы можете редактировать файлы с помощью веб -интерфейса GitHub, используя значок карандаша, как показано в видео с началом работы. В качестве альтернативы, если у вас есть опыт работы с 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 локально, установите среду Conda, как описано в build . Затем вы можете построить рукопись в системах 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 по 4,0 ( LICENSE.md ), что позволяет повторно использовать с атрибуцией. Пожалуйста, атрибут, ссылаясь на https://github.com/manubot/try-manubot.
Поскольку CC BY не идеально подходит для кода и данных, определенные компоненты репозитория также выпускаются в соответствии с посвящением общественного достояния CC0 1.0 ( LICENSE-CC0.md ). Все файлы, сопоставленные следующими шаблонами глобуса, двойные лицензированы в CC By 4.0 и CC0 1.0:
*.sh*.py*.yml / *.yaml*.json*.bib*.tsv.gitignoreВсе остальные файлы доступны только в CC B -4.0, включая:
*.md*.html*.pdf*.docxПожалуйста, откройте вопрос для любого вопроса, связанного с лицензированием.
