該存儲庫包含一個演示手稿,目的是使用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請為與許可有關的任何問題打開一個問題。