try manubot - try manubot Source Source Download

try manubot

ซอร์สโค้ดอื่น ๆ

1.0.0

ดาวน์โหลด

ลอง Manubot: ฝึกการแก้ไขต้นฉบับนี้

คำอธิบายต้นฉบับ

พื้นที่เก็บข้อมูลนี้มีต้นฉบับตัวอย่างซึ่งมีจุดประสงค์เพื่อเป็นสนามเด็กเล่นสำหรับทุกคนในการฝึกฝนโดยใช้ Manubot

ในการแก้ไขต้นฉบับให้ทำการเปลี่ยนแปลงไฟล์ในไดเรกทอรี content คุณสามารถแก้ไขไฟล์ด้วยเว็บอินเตอร์เฟส GitHub โดยใช้ไอคอนดินสอดังที่แสดงในวิดีโอการเริ่มต้นใช้งาน อีกทางเลือกหนึ่งหากคุณมีประสบการณ์กับ Git และ GitHub คุณสามารถแยกที่เก็บนี้และทำคำขอดึงแบบดั้งเดิม

มะม่วง

Manubot เป็นระบบสำหรับการเขียนต้นฉบับทางวิชาการผ่าน GitHub Manubot อัตโนมัติการอ้างอิงและการอ้างอิงรุ่นต้นฉบับโดยใช้ GIT และเปิดใช้งานการเขียนร่วมกันผ่าน GitHub ภาพรวมต้นฉบับนำเสนอประโยชน์ของการเขียนร่วมกันกับ Manubot และคุณสมบัติที่เป็นเอกลักษณ์ ที่เก็บรูทสต็อกเป็นเทมเพลตวัตถุประสงค์ทั่วไปสำหรับการสร้างอินสแตนซ์ของ Manubot ใหม่ตามรายละเอียดใน SETUP.md ดู USAGE.md สำหรับเอกสารวิธีการเขียนต้นฉบับ

โปรดเปิดปัญหาสำหรับคำถามที่เกี่ยวข้องกับการใช้งาน Manubot รายงานข้อผิดพลาดหรือการสอบถามทั่วไป

ไดเรกทอรีและไฟล์ที่เก็บข้อมูล

ไดเรกทอรีมีดังนี้:

content มีแหล่งต้นฉบับซึ่งรวมถึงไฟล์ markdown รวมถึงอินพุตสำหรับการอ้างอิงและการอ้างอิง ดู 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 script และ manubot webpage เมื่อมีการเปลี่ยนแปลงเนื้อหา:

bash build/autobuild.sh

การบูรณาการอย่างต่อเนื่อง

เมื่อใดก็ตามที่มีการเปิดคำขอดึง CI (การรวมอย่างต่อเนื่อง) จะทดสอบว่าการเปลี่ยนแปลงจะทำลายกระบวนการสร้างเพื่อสร้างต้นฉบับที่จัดรูปแบบหรือไม่ กระบวนการสร้างมีวัตถุประสงค์เพื่อตรวจจับข้อผิดพลาดทั่วไปเช่นการอ้างอิงที่ไม่ถูกต้อง หากการสร้างคำขอดึงของคุณล้มเหลวให้ดูบันทึก CI สำหรับสาเหตุของความล้มเหลวและแก้ไขคำขอดึงของคุณตามลำดับ

เมื่อมีการประชุมกับสาขา main เกิดขึ้น (ตัวอย่างเช่นเมื่อมีการรวมคำขอดึง) CI จะสร้างต้นฉบับและเขียนผลลัพธ์ไปยัง gh-pages และสาขา output สาขา gh-pages ใช้หน้า GitHub เพื่อโฮสต์ URL ต่อไปนี้:

HTML ต้นฉบับ ที่ https://manubot.github.io/try-manubot/
PDF ต้นฉบับ ที่ https://manubot.github.io/try-manubot/manuscript.pdf

สำหรับรายละเอียดการกำหนดค่าการรวมอย่างต่อเนื่องดู .github/workflows/manubot.yaml

ใบอนุญาต

ยกเว้นเมื่อระบุไว้เป็นอย่างอื่นที่เก็บข้อมูลทั้งหมดนี้ได้รับอนุญาตภายใต้ CC โดยใบอนุญาต 4.0 ( LICENSE.md ) ซึ่งอนุญาตให้นำกลับมาใช้ใหม่ด้วยการระบุแหล่งที่มา กรุณาคุณลักษณะโดยการเชื่อมโยงไปที่ https://github.com/manubot/try-manubot

เนื่องจาก CC BY นั้นไม่เหมาะสำหรับรหัสและข้อมูลส่วนประกอบที่เก็บบางอย่างจึงถูกปล่อยออกมาภายใต้การอุทิศโดเมนสาธารณะ CC0 1.0 ( LICENSE-CC0.md ) ไฟล์ทั้งหมดที่ตรงกับรูปแบบลูกโลกต่อไปนี้ได้รับใบอนุญาตคู่ภายใต้ CC โดย 4.0 และ CC0 1.0: