try manubot
1.0.0
يحتوي هذا المستودع على مخطوطة تجريبية ، المقصود كملعب للجميع لممارسة استخدام Manubot.
لتحرير المخطوطة ، قم بإجراء تغييرات على الملفات في دليل content . يمكنك تحرير الملفات باستخدام واجهة الويب Github باستخدام أيقونة القلم الرصاص ، كما هو موضح في الفيديو المباشر. بدلاً من ذلك ، إذا كان لديك خبرة مع GIT و Github ، فيمكنك أن تتفوق على هذا المستودع وتقديم طلب سحب تقليدي.
Manubot هو نظام لكتابة المخطوطات العلمية عبر Github. يقوم Manubot بأتمتة الاستشهادات والمراجع ، ومخطوطات الإصدارات باستخدام GIT ، وتمكين الكتابة التعاونية عبر Github. تقدم مخطوطة نظرة عامة فوائد الكتابة التعاونية مع Manubot وميزاتها الفريدة. يعد مستودع RootStock قالبًا عامًا لإنشاء مثيلات جديدة لمانوبوت ، كما هو مفصل في SETUP.md . شاهد USAGE.md للحصول على الوثائق كيفية كتابة مخطوطة.
يرجى فتح مشكلة عن الأسئلة المتعلقة باستخدام مانوبوت ، أو تقارير الأخطاء ، أو الاستفسارات العامة.
الدلائل على النحو التالي:
content على مصدر المخطوطة ، والذي يتضمن ملفات Markdown بالإضافة إلى مدخلات للاستشهادات والمراجع. شاهد USAGE.md لمزيد من المعلومات.output على المخرجات (الملفات التي تم إنشاؤها) من Manubot بما في ذلك المخطوطات الناتجة. يجب ألا تعدل هذه الملفات يدويًا ، لأنها سوف يتم الكتابة فوقها.webpage هي دليل يهدف إلى تقديم صفحة ويب ثابتة لعرض مخطوطة HTML.build على أوامر وأدوات لبناء المخطوطة.ci يحتوي على ملفات ضرورية للنشر عبر التكامل المستمر. أسهل طريقة لتشغيل Manubot هي استخدام التكامل المستمر لإعادة بناء المخطوطة عندما يتغير المحتوى. إذا كنت ترغب في إنشاء مخطوطة Manubot محليًا ، فقم بتثبيت بيئة كوندا كما هو موضح في 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 التالية:
للاطلاع على تفاصيل تكوين التكامل المستمر ، راجع .github/workflows/manubot.yaml .
إلا عند الإشارة إلى خلاف ذلك ، يتم ترخيص مجمل هذا المستودع بموجب ترخيص CC بمقدار 4.0 ( LICENSE.md ) ، والذي يسمح بإعادة الاستخدام مع الإسناد. يرجى أن تنسب بالربط بـ https://github.com/manubot/try-manubot.
نظرًا لأن CC BY ليس مثاليًا للرمز والبيانات ، يتم إصدار بعض مكونات المستودع أيضًا بموجب تفاني المجال العام CC0 1.0 ( LICENSE-CC0.md ). جميع الملفات التي تتطابق مع أنماط GLOB التالية مرخصة مزدوجة بموجب CC بنسبة 4.0 و CC0 1.0:
*.sh*.py*.yml / *.yaml*.json*.bib*.tsv.gitignoreجميع الملفات الأخرى متوفرة فقط تحت CC بحلول 4.0 ، بما في ذلك:
*.md*.html*.pdf*.docxيرجى فتح مشكلة لأي سؤال يتعلق بالترخيص.
