try manubot
1.0.0
このリポジトリには、マヌボットを使用して練習するための遊び場として意図されたデモ原稿が含まれています。
原稿を編集するには、 contentディレクトリ内のファイルを変更します。 GetStart Videoに示すように、鉛筆アイコンを使用して、GitHub Webインターフェイスでファイルを編集できます。または、GitとGithubの経験がある場合は、このリポジトリをフォークして従来のプルリクエストを作成できます。
Manubotは、Githubを介して学術的な原稿を書くためのシステムです。 Manubotは、Gitを使用して引用と参照、バージョンの原稿を自動化し、GitHubを介した共同記述を可能にします。概要原稿は、Manubotとの共同執筆の利点とそのユニークな機能を提示します。 Lootstockリポジトリは、 SETUP.mdで詳述されているように、新しいManubotインスタンスを作成するための汎用テンプレートです。ドキュメントについては、原稿の書き方についてはUSAGE.md参照してください。
Manubotの使用、バグレポート、または一般的な問い合わせに関連する質問については、問題を開きます。
ディレクトリは次のとおりです。
content 、マークダウンファイルと引用や参照の入力が含まれる原稿ソースが含まれています。詳細については、 USAGE.md参照してください。output 、結果の原稿を含むManubotからの出力（生成されたファイル）が含まれます。これらのファイルは上書きされるため、これらのファイルを手動で編集しないでください。webpage 、HTML原稿を表示するための静的Webページとしてレンダリングされることを目的としたディレクトリです。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を参照してください。
特に明記した場合を除き、このリポジトリ全体は4.0ライセンス（ LICENSE.md ）でCCの下でライセンスされており、帰属で再利用できます。 https://github.com/manubot/try-manubotにリンクして属性を持ってください。
CC BYはコードやデータに理想的ではないため、特定のリポジトリコンポーネントはCC0 1.0パブリックドメインの献身（ LICENSE-CC0.md ）の下でもリリースされます。次のグローブパターンに一致するすべてのファイルは、4.0およびCC0 1.0でCCに基づいてデュアルライセンスされています。
*.sh*.py*.yml / *.yaml*.json*.bib*.tsv.gitignore他のすべてのファイルは、次のものを含めて、CCで4.0ごとにのみ利用可能です。
*.md*.html*.pdf*.docxライセンスに関連する質問については、問題を開いてください。
