ai folio
1.0.0
ธีม Jekyll ที่เรียบง่าย สะอาดตา และตอบสนองสำหรับนักวิชาการ ถ้าคุณชอบธีมนี้ ให้ดาวเลย!
ต้องการเรียนรู้เพิ่มเติมเกี่ยวกับเจคิลล์หรือไม่? ลองดูบทช่วยสอนนี้ ทำไมต้องเจคิลล์? อ่านโพสต์บล็อกของ Andrej Karpathy!
สำหรับคำแนะนำแบบลงมือปฏิบัติจริงในการติดตั้ง al-folio โปรดดูวิดีโอสอนการใช้งานสุดเจ๋งนี้โดยหนึ่งในสมาชิกชุมชน! - -
วิธีที่ต้องการใช้เทมเพลตนี้คือการคลิกใช้เทมเพลตนี้เหนือรายการไฟล์ จากนั้น สร้างพื้นที่เก็บข้อมูลใหม่ที่ github.com:<your-username>/<your-repo-name> หากคุณวางแผนที่จะอัปโหลดเว็บไซต์ของคุณไปที่ <your-github-username>.github.io โปรดทราบว่าชื่อของพื้นที่เก็บข้อมูลของคุณต้องเป็น <your-github-username>.github.io หรือ <your-github-orgname>.github.io ตามที่ระบุไว้ในเอกสารหน้า GitHub สำหรับข้อมูลเพิ่มเติมเกี่ยวกับวิธีการปรับใช้เว็บไซต์ของคุณ โปรดดูส่วนการปรับใช้งานด้านล่าง หลังจากที่คุณสร้างที่เก็บใหม่แล้ว เพียงดาวน์โหลดลงในเครื่องของคุณ:
$ git clone [email protected]: < your-username > / < your-repo-name > .git
$ cd < your-repo-name > การใช้ Docker เพื่อติดตั้งการพึ่งพา Jekyll และ Ruby เป็นวิธีที่ง่ายที่สุด
คุณต้องทำตามขั้นตอนต่อไปนี้เพื่อเริ่มการทำงาน al-folio บนเครื่องของคุณ:
$ docker compose pull
$ docker compose upโปรดทราบว่าเมื่อคุณเรียกใช้งานเป็นครั้งแรก ระบบจะดาวน์โหลดอิมเมจนักเทียบท่าขนาด 400MB หรือมากกว่านั้น
ตอนนี้ คุณสามารถปรับแต่งธีมได้ตามต้องการ (อย่าลืมเปลี่ยนชื่อ!) หลังจากเสร็จสิ้น คุณสามารถใช้คำสั่งเดียวกัน ( docker compose up ) เพื่อแสดงหน้าเว็บตามการเปลี่ยนแปลงทั้งหมดของคุณ นอกจากนี้ อย่าลืมทำการเปลี่ยนแปลงครั้งสุดท้ายด้วย
หากต้องการเปลี่ยนหมายเลขพอร์ต คุณสามารถแก้ไขไฟล์
docker-compose.ymlได้
หมายเหตุ: วิธีการนี้จำเป็นเฉพาะในกรณีที่คุณต้องการสร้าง al-folio เวอร์ชันเก่าหรือแบบกำหนดเองมาก
สร้างและรันอิมเมจนักเทียบท่าใหม่โดยใช้:
$ docker compose up --buildหากคุณต้องการอัปเดต jekyll ติดตั้งแพ็คเกจ Ruby ใหม่ ฯลฯ สิ่งที่คุณต้องทำคือสร้างอิมเมจอีกครั้งโดยใช้
--force-recreateอาร์กิวเมนต์ที่ส่วนท้ายของคำสั่งก่อนหน้า! มันจะดาวน์โหลด Ruby และ Jekyll และติดตั้งแพ็คเกจ Ruby ทั้งหมดอีกครั้งตั้งแต่เริ่มต้น
หากคุณต้องการใช้เวอร์ชันนักเทียบท่าเฉพาะ คุณสามารถทำได้โดยเปลี่ยนแท็ก latest เป็น your_version ใน docker-compose.yaml ตัวอย่างเช่น คุณอาจสร้างเว็บไซต์ของคุณบน v0.10.0 และคุณต้องการที่จะยึดติดกับสิ่งนั้นต่อไป
สมมติว่าคุณติดตั้ง Ruby และ Bundler บนระบบของคุณ ( คำแนะนำ: เพื่อความสะดวกในการจัดการ Ruby Gems ให้พิจารณาใช้ rbenv ) รวมถึง Python และ pip ( คำแนะนำ: เพื่อความสะดวกในการจัดการแพ็คเกจ Python ให้พิจารณาใช้สภาพแวดล้อมเสมือน เช่น venv หรือ conda หากคุณจะใช้เพียง jupyter คุณสามารถใช้ pipx )
$ bundle install
# assuming pip is your Python package manager
$ pip install jupyter
$ bundle exec jekyll serve --lsiตอนนี้ คุณสามารถปรับแต่งธีมได้ตามต้องการ (อย่าลืมเปลี่ยนชื่อ!) หลังจากเสร็จสิ้น ให้ยอมรับ การเปลี่ยนแปลงครั้งสุดท้าย
การปรับใช้เว็บไซต์ของคุณกับ GitHub Pages เป็นตัวเลือกที่ได้รับความนิยมมากที่สุด ตั้งแต่เวอร์ชัน v0.3.5 เป็นต้นไป al-folio จะปรับใช้หน้าเว็บของคุณอีกครั้งโดยอัตโนมัติทุกครั้งที่คุณพุชการเปลี่ยนแปลงใหม่ไปยังที่เก็บของคุณ!
สำหรับหน้าเว็บส่วนบุคคลและองค์กร:
<your-github-username>.github.io หรือ <your-github-orgname>.github.io_config.yml ให้ตั้งค่า url เป็น https://<your-github-username>.github.io และปล่อยให้ baseurl ว่างไว้<your-github-username>.github.ioสำหรับหน้าโครงการ:
_config.yml ให้ตั้งค่า url เป็น https://<your-github-username>.github.io และ baseurl เป็น /<your-repository-name>/<your-github-username>.github.io/<your-repository-name>/หากต้องการเปิดใช้งานการปรับใช้อัตโนมัติ:
master แล้ว ตอนนี้พื้นที่เก็บข้อมูลของคุณควรมีสาขา gh-pages ที่สร้างขึ้นใหม่gh-pages ( ไม่ใช่ เป็น master ) สำหรับรายละเอียดเพิ่มเติม โปรดดูที่การกำหนดค่าแหล่งการเผยแพร่สำหรับไซต์ GitHub Pages ของคุณ หากคุณเก็บไซต์ของคุณไว้ที่สาขาอื่น ให้เปิด .github/workflows/deploy.yml ในสาขาที่คุณเปิดเว็บไซต์ไว้ และเปลี่ยน on->push->branches และ on->pull_request->branches เป็นสาขาที่คุณเก็บเว็บไซต์ของคุณไว้ บน. สิ่งนี้จะทริกเกอร์การดำเนินการในการดึง/ดันบนสาขานั้น การดำเนินการจะปรับใช้เว็บไซต์ในสาขาที่ถูกทริกเกอร์
หากคุณต้องการปรับใช้เว็บไซต์ของคุณอีกครั้งในหน้า GitHub ด้วยตนเอง ให้ไปที่การดำเนินการ คลิก "ปรับใช้" ในแถบด้านข้างด้านซ้าย จากนั้น "เรียกใช้เวิร์กโฟลว์"
หากคุณตัดสินใจที่จะไม่ใช้เพจ GitHub และโฮสต์เพจของคุณที่อื่น เพียงเรียกใช้:
$ bundle exec jekyll build --lsi ซึ่งจะ (ใหม่) สร้างหน้าเว็บแบบคงที่ในโฟลเดอร์ _site/ จากนั้นเพียงคัดลอกเนื้อหาของไดเร็กทอรี _site/ ไปยังเซิร์ฟเวอร์โฮสต์ของคุณ
หากคุณต้องการลบคลาส css ที่ไม่ได้ใช้ออกจากไฟล์ของคุณ ให้รัน:
$ purgecss -c purgecss.config.js ซึ่งจะแทนที่ไฟล์ css ในโฟลเดอร์ _site/assets/css/ ด้วยไฟล์ css ที่ถูกลบทิ้ง
หมายเหตุ: ตรวจสอบให้แน่ใจว่าได้ตั้งค่าฟิลด์ url และ baseurl ใน _config.yml อย่างถูกต้องก่อนที่จะสร้างเว็บเพจ หากคุณกำลังปรับใช้หน้าเว็บของคุณกับ your-domain.com/your-project/ คุณต้องตั้งค่า url: your-domain.com และ baseurl: /your-project/ หากคุณกำลังปรับใช้โดยตรงกับ your-domain.com ให้เว้น baseurl ว่างไว้
หมายเหตุ: อย่าลองใช้วิธีนี้ เว้นแต่คุณจะรู้ว่ากำลังทำอะไรอยู่ (ตรวจสอบให้แน่ใจว่าคุณคุ้นเคยกับแหล่งที่มาของการเผยแพร่) วิธีนี้ช่วยให้มีซอร์สโค้ดของเว็บไซต์ในที่เก็บเดียวและมีเวอร์ชันการใช้งานในที่เก็บอื่น
สมมติว่าแหล่งเผยแพร่ของเว็บไซต์ของคุณเป็นไดเร็กทอรี publishing-source ของพื้นที่เก็บข้อมูลรุ่น git ที่ถูกโคลนภายใต้ $HOME/repo/ สำหรับไซต์ผู้ใช้ $HOME/<user>.github.io อาจเป็นเช่นนี้
ประการแรก จาก repo dir การปรับใช้ ให้ชำระเงินสาขา git ที่โฮสต์แหล่งการเผยแพร่ของคุณ
จากนั้นจากแหล่งที่มาของเว็บไซต์ dir (โดยทั่วไปคือโคลนของ al-folio fork ของคุณ):
$ bundle exec jekyll build --lsi --destination $HOME /repo/publishing-source สิ่งนี้จะสั่งให้ jekyll ปรับใช้เว็บไซต์ภายใต้ $HOME/repo/publishing-source
หมายเหตุ: Jekyll จะทำความสะอาด $HOME/repo/publishing-source ก่อนสร้าง!
คำพูดด้านล่างนำมาจากเอกสารการกำหนดค่า jekyll โดยตรง:
โฟลเดอร์ปลายทางจะถูกล้างข้อมูลบนไซต์บิลด์
เนื้อหาของ
<destination>จะถูกล้างโดยอัตโนมัติตามค่าเริ่มต้น เมื่อไซต์ถูกสร้างขึ้น ไฟล์หรือโฟลเดอร์ที่ไซต์ของคุณไม่ได้สร้างขึ้นจะถูกลบออก ไฟล์บางไฟล์สามารถเก็บรักษาไว้ได้โดยการระบุไฟล์เหล่านั้นภายในคำสั่งการกำหนดค่า<keep_files>อย่าใช้ตำแหน่งที่สำคัญสำหรับ
<destination>; ให้ใช้เป็นพื้นที่จัดเตรียมและคัดลอกไฟล์จากที่นั่นไปยังเว็บเซิร์ฟเวอร์ของคุณแทน
หาก $HOME/repo/publishing-source มีไฟล์ที่คุณต้องการให้ jekyll ไม่ถูกแตะต้อง ให้ระบุไฟล์เหล่านั้นภายใต้ keep_files ใน _config.yml ในการกำหนดค่าเริ่มต้น al-folio จะคัดลอก README.md ระดับบนสุดไปยังแหล่งเผยแพร่ หากคุณต้องการเปลี่ยนลักษณะการทำงานนี้ ให้เพิ่ม README.md ภายใต้ exclude ใน _config.yml
หมายเหตุ: ห้าม รัน jekyll clean บน repo แหล่งการเผยแพร่ของคุณ เนื่องจากจะส่งผลให้ไดเร็กทอรีทั้งหมดถูกลบ โดยไม่คำนึงถึงเนื้อหาของ keep_files ใน _config.yml
หากคุณติดตั้ง al-folio ตามที่อธิบายไว้ข้างต้น คุณสามารถกำหนดค่าการดำเนินการ GitHub เพื่อซิงค์พื้นที่เก็บข้อมูลของคุณกับธีมเวอร์ชันล่าสุดโดยอัตโนมัติ
ไปที่การตั้งค่า -> การดำเนินการ -> ทั่วไป -> สิทธิ์เวิร์กโฟลว์ ให้สิทธิ์อ่านและเขียนแก่การดำเนินการ GitHub ทำเครื่องหมายที่ "อนุญาตให้การดำเนินการ GitHub สร้างและอนุมัติคำขอดึง" และบันทึกการเปลี่ยนแปลงของคุณ
จากนั้นไปที่การดำเนินการ -> เวิร์กโฟลว์ใหม่ -> ตั้งค่าเวิร์กโฟลว์ด้วยตนเอง ตั้งค่าเวิร์กโฟลว์ต่อไปนี้และยอมรับการเปลี่ยนแปลงของคุณ:
name : Sync from template
on :
# cronjob trigger
schedule :
- cron : " 0 0 1 * * "
# manual trigger
workflow_dispatch :
jobs :
repo-sync :
runs-on : ubuntu-latest
steps :
# To use this repository's private action, you must check out the repository
- name : Checkout
uses : actions/checkout@v3
- name : actions-template-sync
uses : AndreasAugustin/[email protected]
with :
github_token : ${{ secrets.GITHUB_TOKEN }}
source_repo_path : alshedivat/al-folio
upstream_branch : masterคุณจะได้รับคำขอดึงภายในพื้นที่เก็บข้อมูลของคุณหากมีการเปลี่ยนแปลงบางอย่างในเทมเพลต
อีกทางเลือกหนึ่งคืออัปเดตโค้ดของคุณด้วยตนเองโดยทำตามขั้นตอนด้านล่าง:
# Assuming the current directory is <your-repo-name>
$ git remote add upstream https://github.com/alshedivat/al-folio.git
$ git fetch upstream
$ git rebase v0.9.0 หากคุณได้ปรับแต่งเวอร์ชันก่อนหน้าอย่างกว้างขวาง การอัพเกรดอาจยุ่งยากกว่า คุณยังคงสามารถทำตามขั้นตอนข้างต้นได้ แต่ git rebase อาจส่งผลให้เกิดข้อขัดแย้งในการผสานที่ต้องแก้ไข ดูคู่มือ git rebase และวิธีแก้ไขข้อขัดแย้งสำหรับข้อมูลเพิ่มเติม หากการรีบูตซับซ้อนเกินไป เราขอแนะนำให้ติดตั้งธีมเวอร์ชันใหม่ใหม่ตั้งแต่ต้นและย้ายไปยังเนื้อหาของคุณและเปลี่ยนแปลงจากเวอร์ชันก่อนหน้าด้วยตนเอง
ต่อไปนี้เป็นคำถามที่พบบ่อย หากคุณมีคำถามอื่น โปรดถามโดยใช้การสนทนา
ถาม: หลังจากที่ฉันสร้างพื้นที่เก็บข้อมูลใหม่จากเทมเพลตนี้และตั้งค่า repo แล้ว ฉันพบข้อผิดพลาดในการปรับใช้ เว็บไซต์ไม่ควรปรับใช้โดยอัตโนมัติอย่างถูกต้องใช่ไหม
ตอบ: ได้ หากคุณใช้รีลีส v0.3.5 หรือใหม่กว่า เว็บไซต์จะปรับใช้ใหม่โดยอัตโนมัติและถูกต้องทันทีหลังจากที่คุณคอมมิตครั้งแรก โปรดทำการเปลี่ยนแปลงบางอย่าง (เช่น เปลี่ยนข้อมูลเว็บไซต์ของคุณใน _config.yml ) คอมมิต และพุช ตรวจสอบให้แน่ใจว่าได้ทำตามคำแนะนำในการปรับใช้ในส่วนก่อนหน้า (ประเด็นที่เกี่ยวข้อง: 209.)
ถาม: ฉันใช้โดเมนที่กำหนดเอง (เช่น foo.com ) โดเมนที่กำหนดเองของฉันจะว่างเปล่าในการตั้งค่าพื้นที่เก็บข้อมูลหลังจากการปรับใช้แต่ละครั้ง ฉันจะแก้ไขได้อย่างไร?
ตอบ: คุณต้องเพิ่มไฟล์ CNAME ไปยังสาขา master หรือ source ของพื้นที่เก็บข้อมูลของคุณ ไฟล์ควรมีชื่อโดเมนที่คุณกำหนดเอง (ประเด็นที่เกี่ยวข้อง: 130.)
ถาม: หน้าเว็บของฉันทำงานในเครื่อง แต่หลังจากการปรับใช้ มันล้มเหลวในการสร้างและโยน Unknown tag 'toc' ฉันจะแก้ไขได้อย่างไร?
ตอบ: ตรวจสอบให้แน่ใจว่าคุณได้ทำตามคำแนะนำในการปรับใช้ในส่วนก่อนหน้าแล้ว คุณควรตั้งค่าสาขาการปรับใช้เป็น gh-pages (ประเด็นที่เกี่ยวข้อง: 1438.)
ถาม: หน้าเว็บของฉันทำงานในเครื่อง แต่หลังจากปรับใช้แล้ว จะแสดงไม่ถูกต้อง (โหลด CSS และ JS ไม่ถูกต้อง) ฉันจะแก้ไขได้อย่างไร?
ตอบ: ตรวจสอบให้แน่ใจว่าได้ระบุเส้นทาง url และ baseurl ใน _config.yml อย่างถูกต้อง ตั้งค่า url เป็น https://<your-github-username>.github.io หรือเป็น https://<your.custom.domain> หากคุณใช้โดเมนแบบกำหนดเอง หากคุณกำลังปรับใช้เว็บไซต์ส่วนตัวหรือองค์กร ให้เว้น baseurl ว่างไว้ หากคุณกำลังปรับใช้หน้าโปรเจ็กต์ ให้ตั้งค่า baseurl: /<your-project-name>/ หากขั้นตอนก่อนหน้านี้ทั้งหมดทำอย่างถูกต้อง เบราว์เซอร์ของคุณก็จะดึงสไตล์ชีตของไซต์กลับมาอีกครั้ง
ถาม: ฟีด Atom ไม่ทำงาน ทำไม
ตอบ: ตรวจสอบให้แน่ใจว่าได้ระบุเส้นทาง url และ baseurl ใน _config.yml อย่างถูกต้อง ปลั๊กอิน RSS Feed ทำงานร่วมกับฟิลด์ที่ตั้งค่าอย่างถูกต้อง: title , url , description และ author ตรวจสอบให้แน่ใจว่าได้กรอกข้อมูลด้วยวิธีที่เหมาะสมแล้วลองอีกครั้ง
ถาม: ไซต์ของฉันไม่ทำงานเมื่อฉันเปิดใช้งาน related_blog_posts ทำไม
ตอบ: อาจเป็นเพราะปลั๊กอินตัวแยกประเภท Reborn ซึ่งใช้ในการคำนวณโพสต์ที่เกี่ยวข้อง หากข้อผิดพลาดระบุว่า Liquid Exception: Zero vectors can not be normalized... หมายความว่าไม่สามารถคำนวณโพสต์ที่เกี่ยวข้องสำหรับโพสต์เฉพาะได้ ซึ่งมักเกิดจากการโพสต์ในบล็อกที่ว่างเปล่าหรือเพียงเล็กน้อยโดยไม่มีคำที่มีความหมาย (เช่น คำหยุดเท่านั้น) หรือแม้แต่อักขระเฉพาะที่คุณใช้ในโพสต์ของคุณ นอกจากนี้ แคลคูลัสสำหรับโพสต์ที่คล้ายกันนั้นถูกสร้างขึ้นสำหรับทุก post ซึ่งหมายถึงทุกเพจที่ใช้ layout: post รวมถึงประกาศด้วย หากต้องการเปลี่ยนพฤติกรรมนี้ เพียงเพิ่ม related_posts: false ไว้ที่ส่วนหน้าของเพจที่คุณไม่ต้องการแสดงโพสต์ที่เกี่ยวข้อง
ถาม: เมื่อพยายามปรับใช้ ระบบจะถามข้อมูลรับรองการเข้าสู่ระบบ GitHub ซึ่ง GitHub ใดที่ปิดใช้งานการตรวจสอบสิทธิ์ด้วยรหัสผ่าน และออกโดยมีข้อผิดพลาด จะแก้ไขอย่างไร?
ตอบ: เปิดไฟล์ .git/config โดยใช้โปรแกรมแก้ไขที่คุณต้องการ เปลี่ยนส่วน https ของตัวแปร url เป็น ssh ลองปรับใช้อีกครั้ง
หน้าสิ่งพิมพ์ของคุณถูกสร้างขึ้นโดยอัตโนมัติจากบรรณานุกรม BibTex ของคุณ เพียงแก้ไข _bibliography/papers.bib คุณยังสามารถเพิ่มไฟล์ *.bib ใหม่และปรับแต่งรูปลักษณ์ของสิ่งพิมพ์ของคุณได้ตามที่คุณต้องการโดยแก้ไข _pages/publications.md
ในสิ่งพิมพ์ รายการผู้เขียนสำหรับตัวคุณเองจะถูกระบุโดย string array scholar:last_name และ string array scholar:first_name ใน _config.yml :
scholar :
last_name : [Einstein]
first_name : [Albert, A.] หากรายการตรงกับนามสกุลและชื่อรูปแบบใดรูปแบบหนึ่ง ระบบจะขีดเส้นใต้ เก็บข้อมูลเมตาเกี่ยวกับผู้เขียนร่วมของคุณใน _data/coauthors.yml และ Jekyll จะแทรกลิงก์ไปยังหน้าเว็บของพวกเขาโดยอัตโนมัติ รูปแบบข้อมูลผู้เขียนร่วมใน _data/coauthors.yml มีดังนี้
" Adams " :
- firstname : ["Edwin", "E.", "E. P.", "Edwin Plimpton"]
url : https://en.wikipedia.org/wiki/Edwin_Plimpton_Adams
" Podolsky " :
- firstname : ["Boris", "B.", "B. Y.", "Boris Yakovlevich"]
url : https://en.wikipedia.org/wiki/Boris_Podolsky
" Rosen " :
- firstname : ["Nathan", "N."]
url : https://en.wikipedia.org/wiki/Nathan_Rosen
" Bach " :
- firstname : ["Johann Sebastian", "J. S."]
url : https://en.wikipedia.org/wiki/Johann_Sebastian_Bach
- firstname : ["Carl Philipp Emanuel", "C. P. E."]
url : https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_Bachหากรายการตรงกับการผสมระหว่างนามสกุลและชื่อ รายการนั้นจะถูกเน้นและเชื่อมโยงกับ URL ที่ให้ไว้
มีคำสำคัญ bibtex แบบกำหนดเองหลายคำที่คุณสามารถใช้เพื่อส่งผลต่อวิธีการแสดงรายการบนเว็บเพจ:
abbr : เพิ่มตัวย่อทางด้านซ้ายของรายการ คุณสามารถเพิ่มลิงก์ไปยังลิงก์เหล่านี้ได้โดยสร้างไฟล์ place.yaml ในโฟลเดอร์ _data และเพิ่มรายการที่ตรงกันabstract : เพิ่มปุ่ม "Abs" ที่ขยายช่องข้อความที่ซ่อนอยู่เมื่อคลิกเพื่อแสดงข้อความนามธรรมarxiv : เพิ่มลิงก์ไปยังเว็บไซต์ Arxiv (หมายเหตุ: เพิ่มเฉพาะตัวระบุ arxiv ที่นี่ - ลิงก์จะถูกสร้างขึ้นโดยอัตโนมัติ)bibtex_show : เพิ่มปุ่ม "Bib" ที่ขยายช่องข้อความที่ซ่อนอยู่พร้อมกับรายการบรรณานุกรมแบบเต็มhtml : แทรกปุ่ม "HTML" เพื่อเปลี่ยนเส้นทางไปยังลิงก์ที่ผู้ใช้ระบุpdf : เพิ่มปุ่ม "PDF" เพื่อเปลี่ยนเส้นทางไปยังไฟล์ที่ระบุ (หากไม่ได้ระบุลิงก์แบบเต็ม ไฟล์จะถือว่าอยู่ในไดเร็กทอรี /assets/pdf/)supp : เพิ่มปุ่ม "Supp" ให้กับไฟล์ที่ระบุ (หากไม่ได้ระบุลิงก์แบบเต็ม ไฟล์จะถือว่าอยู่ในไดเร็กทอรี /assets/pdf/)blog : เพิ่มปุ่ม "Blog" เพื่อเปลี่ยนเส้นทางไปยังลิงค์ที่ระบุcode : เพิ่มปุ่ม "Code" เพื่อเปลี่ยนเส้นทางไปยังลิงค์ที่ระบุposter : เพิ่มปุ่ม "โปสเตอร์" เพื่อเปลี่ยนเส้นทางไปยังไฟล์ที่ระบุ (หากไม่ได้ระบุลิงก์แบบเต็ม ไฟล์จะถือว่าอยู่ในไดเร็กทอรี /assets/pdf/)slides : เพิ่มปุ่ม "สไลด์" เพื่อเปลี่ยนเส้นทางไปยังไฟล์ที่ระบุ (หากไม่ได้ระบุลิงก์แบบเต็ม ไฟล์จะถือว่าอยู่ในไดเร็กทอรี /assets/pdf/)website : เพิ่มปุ่ม "เว็บไซต์" เพื่อเปลี่ยนเส้นทางไปยังลิงก์ที่ระบุaltmetric : เพิ่มป้าย Altmetric (หมายเหตุ: หากมีการระบุ DOI ให้ใช้ true มิฉะนั้นให้เพิ่มเฉพาะตัวระบุ Altmetric ที่นี่ - ลิงก์จะถูกสร้างขึ้นโดยอัตโนมัติ)dimensions : เพิ่มป้ายขนาด (หมายเหตุ: หากมีการระบุ DOI หรือ PMID เพียงใช้ true มิฉะนั้นให้เพิ่มเฉพาะตัวระบุของขนาดที่นี่ - ลิงก์จะถูกสร้างขึ้นโดยอัตโนมัติ)คุณสามารถใช้ปุ่มของคุณเองได้โดยแก้ไขไฟล์ bib.html
ธีม Jekyll นี้ใช้ collections ชันเพื่อให้คุณสามารถแบ่งงานของคุณออกเป็นหมวดหมู่ได้ ธีมนี้มาพร้อมกับคอลเลกชั่นเริ่มต้นสองคอลเลกชั่น: news และ projects รายการจากคอลเลกชัน news จะแสดงบนหน้าแรกโดยอัตโนมัติ รายการจากคอลเลกชัน projects จะแสดงบนตารางตอบสนองบนหน้าโครงการ
คุณสามารถสร้างคอลเลกชั่น แอพ เรื่องสั้น หลักสูตร หรืองานสร้างสรรค์อะไรก็ตามของคุณเองได้อย่างง่ายดาย เมื่อต้องการทำเช่นนี้ ให้แก้ไขคอลเลกชันในไฟล์ _config.yml สร้างโฟลเดอร์ที่เกี่ยวข้อง และสร้างแลนดิ้งเพจสำหรับคอลเลกชันของคุณ ซึ่งคล้ายกับ _pages/projects.md
al-folio มาพร้อมกับรูปแบบที่มีสไตล์สำหรับหน้าและโพสต์บล็อก
ธีมนี้ช่วยให้คุณสร้างบล็อกโพสต์ในรูปแบบ distill.pub:
สำหรับรายละเอียดเพิ่มเติมเกี่ยวกับวิธีการสร้างโพสต์สไตล์การกลั่นโดยใช้แท็ก <d-*> โปรดดูตัวอย่าง
al-folio รองรับการเรียงพิมพ์ทางคณิตศาสตร์อย่างรวดเร็วผ่าน MathJax และการเน้นไวยากรณ์โค้ดโดยใช้สไตล์ GitHub:
การจัดรูปแบบภาพถ่ายทำได้ง่ายโดยใช้ระบบกริดของ Bootstrap สร้างกริดที่สวยงามได้อย่างง่ายดายภายในบล็อกโพสต์และหน้าโครงการของคุณ:
al-folio ใช้ github-readme-stats และ github-profile-trophy เพื่อแสดงที่เก็บ GitHub และสถิติผู้ใช้บนหน้า /repositories/
แก้ไข _data/repositories.yml และเปลี่ยนรายการ github_users และ github_repos เพื่อรวมโปรไฟล์ GitHub และที่เก็บของคุณไปที่เพจ /repositories/
คุณอาจใช้รหัสต่อไปนี้เพื่อแสดงสิ่งนี้ในหน้าอื่น ๆ
<!-- code for GitHub users -->
{% if site.data.repositories.github_users %}
< div class =" repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center " >
{% for user in site.data.repositories.github_users %}
{% include repository/repo_user.html username=user %}
{% endfor %}
</ div >
{% endif %}
<!-- code for GitHub trophies -->
{% if site.repo_trophies.enabled %}
{% for user in site.data.repositories.github_users %}
{% if site.data.repositories.github_users.size > 1 %}
< h4 > {{ user }} </ h4 >
{% endif %}
< div class =" repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center " >
{% include repository/repo_trophies.html username=user %}
</ div >
{% endfor %}
{% endif %}
<!-- code for GitHub repositories -->
{% if site.data.repositories.github_repos %}
< div class =" repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center " >
{% for repo in site.data.repositories.github_repos %}
{% include repository/repo.html repository=repo %}
{% endfor %}
</ div >
{% endif %} มีการเลือกธีมสีสวยงามหลากหลายให้คุณเลือก ค่าเริ่มต้นคือสีม่วง แต่คุณสามารถเปลี่ยนได้อย่างรวดเร็วโดยแก้ไขตัวแปร --global-theme-color ในไฟล์ _sass/_themes.scss ตัวแปรสีอื่นๆ ก็แสดงอยู่ที่นั่นเช่นกัน สามารถดูตัวเลือกสีของธีมสต็อกได้ที่ _sass/_variables.scss คุณยังสามารถเพิ่มสีของคุณเองลงในไฟล์นี้โดยกำหนดชื่อให้แต่ละชื่อเพื่อให้ง่ายต่อการใช้งานทั่วทั้งเทมเพลต
al-folio รองรับภาพตัวอย่างบนโซเชียลมีเดีย หากต้องการเปิดใช้งานฟังก์ชันนี้ คุณจะต้องตั้งค่า serve_og_meta เป็น true ใน _config.yml ของคุณ เมื่อคุณดำเนินการดังกล่าวแล้ว หน้าเว็บไซต์ทั้งหมดจะรวมข้อมูล Open Graph ไว้ในองค์ประกอบส่วนหัว HTML
จากนั้นคุณจะต้องกำหนดค่ารูปภาพที่จะแสดงในตัวอย่างโซเชียลมีเดียของเว็บไซต์ของคุณ ซึ่งสามารถกำหนดค่าได้แบบต่อหน้า โดยการตั้งค่าตัวแปรหน้า og_image หากไม่ได้ตั้งค่าตัวแปรนี้สำหรับแต่ละเพจ ธีมจะถอยกลับไปเป็นตัวแปร og_image ทั่วทั้งไซต์ ซึ่งสามารถกำหนดค่าได้ใน _config.yml ของคุณ ในกรณีเฉพาะหน้าและทั้งไซต์ ตัวแปร og_image จำเป็นต้องเก็บ URL สำหรับรูปภาพที่คุณต้องการแสดงในตัวอย่างโซเชียลมีเดีย
สร้างฟีด Atom (คล้าย RSS) สำหรับโพสต์ของคุณ ซึ่งมีประโยชน์สำหรับผู้อ่าน Atom และ RSS เข้าถึงฟีดได้อย่างง่ายดายโดยพิมพ์หลังหน้าแรกของคุณ /feed.xml เช่น สมมติว่าจุดเมานต์เว็บไซต์ของคุณเป็นโฟลเดอร์หลัก คุณสามารถพิมพ์ yourusername.github.io/feed.xml
ตามค่าเริ่มต้น จะมีส่วนโพสต์ที่เกี่ยวข้องที่ด้านล่างของโพสต์ในบล็อก สิ่งเหล่านี้สร้างขึ้นโดยการเลือกโพสต์ล่าสุดที่ max_related ที่แชร์แท็ก min_common_tags เป็นอย่างน้อยกับโพสต์ปัจจุบัน หากคุณไม่ต้องการแสดงโพสต์ที่เกี่ยวข้องในโพสต์ใดโพสต์หนึ่ง เพียงเพิ่ม related_posts: false ไว้ที่ส่วนหน้าของโพสต์ หากคุณต้องการปิดการใช้งานสำหรับโพสต์ทั้งหมด เพียงตั้ง enabled เป็นเท็จในส่วน related_blog_posts ใน _config.yml
เรายินดีเป็นอย่างยิ่งที่จะมีส่วนร่วมใน al-folio! ก่อนที่คุณจะเริ่มต้น โปรดดูหลักเกณฑ์
หากคุณต้องการปรับปรุงเอกสาร เพิ่มหน้าเว็บของคุณลงในรายการด้านล่าง หรือแก้ไขความไม่สอดคล้องกันหรือข้อบกพร่องเล็กน้อย โปรดส่ง PR โดยตรงไปที่ master สำหรับปัญหา/ข้อบกพร่อง หรือการร้องขอคุณสมบัติที่ซับซ้อนมากขึ้น โปรดเปิดปัญหาโดยใช้เทมเพลตที่เหมาะสม
เรายินดีต้อนรับผู้มีส่วนร่วมที่กระตือรือร้นที่สุดให้เข้าร่วมทีมผู้ดูแล หากคุณสนใจ โปรดติดต่อ!
มารูอัน | โรฮาน เดบ ซาร์การ์ | อามีร์ ปูร์มันด์ | จอร์จ |
ทำด้วยหินที่มีส่วนร่วม
ธีมนี้พร้อมใช้งานในรูปแบบโอเพ่นซอร์สภายใต้เงื่อนไขของใบอนุญาต MIT
เดิมที al-folio มีพื้นฐานมาจากธีม *folio (เผยแพร่โดย Lia Bogoev และภายใต้ใบอนุญาต MIT) ตั้งแต่นั้นมา ได้มีการเขียนสไตล์ใหม่ทั้งหมดและฟีเจอร์เจ๋งๆ เพิ่มเติมมากมาย
