中文

คุณสมบัติ
ชุมชน
เราอยู่ในภารกิจเพื่อส่งเสริม การวิจัยแบบเปิด โดยการพัฒนาเครื่องมือ โอเพนซอร์ส เช่นนี้
เพื่อช่วยให้เราพัฒนาซอฟต์แวร์โอเพ่นซอร์สนี้อย่างยั่งยืนภายใต้ใบอนุญาต MIT เราขอให้บุคคลและธุรกิจทั้งหมดที่ใช้เพื่อช่วยสนับสนุนการบำรุงรักษาและการพัฒนาอย่างต่อเนื่องผ่านการสนับสนุนและการสนับสนุน
สนับสนุนการเคลื่อนไหวแบบเปิดการวิจัย:
เปิดแอปเทอ ร์มินัล หรือ คำสั่ง ของคุณและป้อนคำสั่งการติดตั้งใด ๆ ด้านล่าง
สำหรับการติดตั้ง ที่ง่ายที่สุด ให้ติดตั้งด้วย pipx:
pipx install academic
PIPX จะ ติดตั้งเวอร์ชัน Python ที่ต้องการโดยอัตโนมัติสำหรับคุณ ในสภาพแวดล้อมเฉพาะ
ในการติดตั้งโดยใช้เครื่องมือ PIP ของ Python ตรวจสอบให้แน่ใจว่าคุณติดตั้ง Python 3.11+ แล้วเรียกใช้:
pip3 install -U academic
เปิดบรรทัดคำสั่งหรือแอพขั้วของคุณและใช้คำสั่ง cd เพื่อนำทางไปยังโฟลเดอร์ที่มีไฟล์ที่คุณต้องการแปลงตัวอย่างเช่น:
cd ~/Documents/my_website
ดาวน์โหลดข้อมูลอ้างอิงจากตัวจัดการอ้างอิงของคุณเช่น Zotero ในรูปแบบ Bibtex
สมมติว่าเราดาวน์โหลดสิ่งพิมพ์ของเราไปยังไฟล์ชื่อ my_publications.bib ภายในโฟลเดอร์เว็บไซต์เรามานำเข้า content/publication/ โฟลเดอร์:
academic import my_publications.bib content/publication/ --compact
อาร์กิวเมนต์เสริม:
--compact สร้าง markdown น้อยที่สุดโดยไม่มีความคิดเห็นหรือปุ่มเปล่า--overwrite เขียนทับสิ่งพิมพ์ที่มีอยู่ในโฟลเดอร์เอาท์พุท--normalize กำหนดแท็กปกติโดยการแปลงเป็นตัวพิมพ์เล็กและใช้ประโยชน์จากตัวอักษรตัวแรก (เช่น "วิทยาศาสตร์" -> "วิทยาศาสตร์")--featured พิมพ์สิ่งพิมพ์เหล่านี้เป็น จุดเด่น (ปรากฏในส่วน สิ่งพิมพ์ที่โดดเด่น ของเว็บไซต์ของคุณ)--verbose หรือ -v แสดงข้อความ verbose--help ช่วยเหลือช่วยเหลือหลังจากนำเข้าสิ่งพิมพ์เราขอแนะนำคุณ:
featured กับโฟลเดอร์ของสิ่งพิมพ์แต่ละแห่งเพื่อแสดงสิ่งพิมพ์ของคุณบนหน้าเว็บและสำหรับการแบ่งปันบนโซเชียลมีเดียเรียนรู้เพิ่มเติมในเอกสาร Hugo Blox
สมมติว่าเรามีสมุดบันทึกของเราในโฟลเดอร์ notebooks ภายในโฟลเดอร์เว็บไซต์ลองนำเข้าสู่ content/post/ โฟลเดอร์:
academic import 'notebooks/*.ipynb' content/post/ --verbose
อาร์กิวเมนต์เสริม:
--overwrite เขียนทับโพสต์บล็อกที่มีอยู่ในโฟลเดอร์เอาท์พุท--verbose หรือ -v แสดงข้อความ verbose--help ช่วยเหลือช่วยเหลือ สนใจที่จะมีส่วนร่วมใน โอเพนซอร์ส และ การวิจัยแบบเปิด หรือไม่?
เรียนรู้วิธีการมีส่วนร่วมรหัสใน GitHub
ตรวจสอบปัญหาที่เปิดกว้างและมีส่วนร่วมในการร้องขอการดึง
สำหรับการพัฒนาในท้องถิ่นโคลนที่เก็บนี้และใช้บทกวีเพื่อติดตั้งและเรียกใช้ตัวแปลงโดยใช้คำสั่งต่อไปนี้:
git clone https://github.com/GetRD/academic-file-converter.git
cd academic-file-converter
poetry install
poetry run academic import tests/data/article.bib output/publication/ --overwrite --compact
poetry run academic import 'tests/data/**/*.ipynb' output/post/ --overwrite --verbose
เมื่อเตรียมการบริจาคให้เรียกใช้การตรวจสอบต่อไปนี้และตรวจสอบให้แน่ใจว่าพวกเขาทั้งหมดผ่าน:
make lintmake formatmake testmake type คุณสามารถช่วยทดสอบเวอร์ชันการพัฒนาล่าสุดโดยการติดตั้งสาขา main ล่าสุดจาก GitHub:
pip3 install -U git+https://github.com/GetRD/academic-file-converter.git
ลิขสิทธิ์ 2018- ปัจจุบัน George Cushen
ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT