try manubot
1.0.0
Repositori ini berisi naskah demo, dimaksudkan sebagai taman bermain bagi semua orang untuk berlatih menggunakan Manubot.
Untuk mengedit naskah, buat perubahan pada file di direktori content . Anda dapat mengedit file dengan antarmuka web GitHub dengan menggunakan ikon pensil, seperti yang ditunjukkan dalam video memulai. Atau, jika Anda memiliki pengalaman dengan Git dan GitHub, Anda dapat membayar repositori ini dan membuat permintaan tarik tradisional.
Manubot adalah sistem untuk menulis naskah ilmiah melalui GitHub. Manubot mengotomatiskan kutipan dan referensi, manuskrip versi menggunakan git, dan memungkinkan penulisan kolaboratif melalui GitHub. Naskah ikhtisar menyajikan manfaat penulisan kolaboratif dengan Manubot dan fitur -fitur uniknya. Repositori Rootstock adalah templat tujuan umum untuk membuat instance Manubot baru, sebagaimana dirinci dalam SETUP.md . Lihat USAGE.md untuk dokumentasi cara menulis naskah.
Harap buka masalah untuk pertanyaan yang terkait dengan penggunaan Manubot, laporan bug, atau pertanyaan umum.
Direktori adalah sebagai berikut:
content berisi sumber naskah, yang mencakup file -file markdown serta input untuk kutipan dan referensi. Lihat USAGE.md untuk informasi lebih lanjut.output berisi output (file yang dihasilkan) dari Manubot termasuk naskah yang dihasilkan. Anda tidak boleh mengedit file -file ini secara manual, karena mereka akan ditimpa.webpage adalah direktori yang dimaksudkan untuk diterjemahkan sebagai halaman web statis untuk melihat naskah HTML.build berisi perintah dan alat untuk membangun naskah.ci berisi file yang diperlukan untuk penyebaran melalui integrasi berkelanjutan. Cara termudah untuk menjalankan Manubot adalah dengan menggunakan integrasi berkelanjutan untuk membangun kembali naskah saat konten berubah. Jika Anda ingin membangun naskah manubot secara lokal, pasang lingkungan Conda seperti yang dijelaskan dalam build . Kemudian, Anda dapat membangun naskah pada sistem POSIX dengan menjalankan perintah berikut dari direktori root ini.
# 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 Terkadang sangat membantu untuk memantau direktori konten dan secara otomatis membangun kembali naskah ketika perubahan terdeteksi. Perintah berikut, saat berjalan, akan memicu skrip build.sh dan perintah manubot webpage setelah perubahan konten:
bash build/autobuild.shSetiap kali permintaan tarik dibuka, CI (integrasi kontinu) akan menguji apakah perubahan tersebut merusak proses pembuatan untuk menghasilkan naskah yang diformat. Proses pembangunan bertujuan untuk mendeteksi kesalahan umum, seperti kutipan yang tidak valid. Jika build permintaan tarik Anda gagal, lihat log CI untuk penyebab kegagalan dan revisi permintaan tarik Anda sesuai.
Ketika komit ke cabang main terjadi (misalnya, ketika permintaan tarik digabungkan), CI membangun naskah dan menulis hasilnya ke gh-pages dan cabang output . Cabang gh-pages menggunakan halaman GitHub untuk meng-host URL berikut:
Untuk detail konfigurasi integrasi berkelanjutan, lihat .github/workflows/manubot.yaml .
Kecuali ketika dicatat sebaliknya, keseluruhan repositori ini dilisensikan di bawah lisensi CC dengan 4.0 ( LICENSE.md ), yang memungkinkan penggunaan kembali dengan atribusi. Harap atribut dengan menautkan ke https://github.com/manubot/try-manubot.
Karena CC BY tidak ideal untuk kode dan data, komponen repositori tertentu juga dirilis di bawah Dedikasi Domain Publik CC0 1.0 ( LICENSE-CC0.md ). Semua file yang cocok dengan pola Glob berikut dilisensikan ganda di bawah CC oleh 4.0 dan CC0 1.0:
*.sh*.py*.yml / *.yaml*.json*.bib*.tsv.gitignoreSemua file lain hanya tersedia di bawah CC oleh 4.0, termasuk:
*.md*.html*.pdf*.docxHarap buka masalah untuk pertanyaan apa pun yang terkait dengan lisensi.
