blip

Blip - เครื่องมือสร้างบล็อกแบบคงที่ Swift/Markdown

ข้อกำหนดเบื้องต้น

Blip ใช้โครงสร้างไดเร็กทอรีเฉพาะสำหรับเทมเพลตและการจัดระเบียบไซต์ ดู example-site/ ไดเร็กทอรีสำหรับการสาธิต หรืออ่านคำอธิบายแบบเต็ม

เทมเพลต

เทมเพลตคือแนวทางการจัดวางสำหรับดัชนีไซต์และหน้าโพสต์ของคุณ ข้อมูลต่อไปนี้อยู่ใน config/templates/ :

• index_template.html : หน้าดัชนีหลักของเว็บไซต์ของคุณ

• index_post_template.html : เค้าโครงของตัวอย่างโพสต์ในหน้าดัชนี

• post_template.html : เค้าโครงของหน้าโพสต์แต่ละหน้า

โทเค็นพิเศษ

Blip ใช้ "โทเค็น" แบบกำหนดเองสำหรับงานทั่วไปและการแทนที่ข้อความ ใช้ Config.swift เพื่อปรับแต่งสตริงทดแทน

Markdown (โพสต์):

• [[MORE]] : แบ่งโพสต์ ณ จุดนี้ในหน้า index*.html และแทรกลิงก์ Read More ไปยังโพสต์แบบเต็ม

แม่แบบ:

• $(COPYRIGHT) : แทรกสตริงลิขสิทธิ์ที่กำหนดเองลงในเทมเพลตดัชนี

• $(POSTS) : แทรกรายการตัวอย่างโพสต์ลงในเทมเพลตดัชนี

• $(POSTS_OLDER) : แทรกลิงก์ "โพสต์เก่า" ลงในเทมเพลตดัชนี

• $(POSTS_NEWER) : แทรกลิงก์ "โพสต์ใหม่" ลงในเทมเพลตดัชนี

• $(POST_TITLE) : แทรกชื่อโพสต์ลงในโพสต์หรือเทมเพลตดัชนี

• $(POST_TIMESTAMP) : แทรกการประทับเวลาของโพสต์ลงในโพสต์หรือเทมเพลตดัชนี

• $(POST_BODY) : แทรกเนื้อหาของโพสต์ลงในโพสต์หรือเทมเพลตดัชนี (เทมเพลตดัชนีจะแสดงโทเค็น [[MORE]] ใดก็ได้)

• $(POST_PERMALINK) : แทรกลิงก์ถาวรของโพสต์ลงในโพสต์หรือเทมเพลตดัชนี

กระทู้

ชื่อไฟล์

โพสต์ควรอยู่ในรูปแบบ Markdown และควรเป็นไปตามรูปแบบการตั้งชื่อ YYYYMMDD.md (รองรับนามสกุลไฟล์ .markdown ด้วย)

โครงสร้างไดเร็กทอรี

posts/ ไดเร็กทอรีควรมีไดเร็กทอรีย่อยอย่างน้อยสองไดเร็กทอรี:

• drafts : นี่คือที่ที่คุณควรวางไฟล์ Markdown (.md) เพื่อการเผยแพร่

• published : Blip จะสร้าง index*.html และโพสต์หน้าในไดเร็กทอรีนี้ คุณควรใช้เนื้อหาของไดเร็กทอรีนี้สำหรับเว็บไซต์ของคุณ

โพสต์ที่เผยแพร่จะจัดเรียงตามวันที่ในชื่อไฟล์ ตัวอย่างเช่น โพสต์ที่มีชื่อไฟล์ 20171220.md จะถูกเผยแพร่ในเส้นทางต่อไปนี้: posts/published/2017/12/20.md ปัจจุบัน Blip รองรับโพสต์เดียวต่อวันเท่านั้น เนื่องจากฉันไม่ได้เขียนบล็อกบ่อยนัก...

สไตล์ชีตและรูปภาพ

• published/stylesheets/ : เทมเพลตเริ่มต้นใช้ index.css ที่รวมไว้เป็นสไตล์ชีต คุณสามารถวางไฟล์ CSS อื่นๆ ที่นี่และอ้างอิงในเทมเพลตของคุณได้ หากจำเป็น

• published/images/ : วางภาพของคุณที่นี่ และคุณสามารถอ้างอิงได้ใน Markdown ดังนี้: ![image](/images/someimage.jpg)

การใช้งาน

เขียนโพสต์ของคุณใน Markdown โดยใช้รูปแบบชื่อไฟล์ที่ถูกต้อง ( YYYYMMDD.md ) จากนั้นวางลงในไดเร็กทอรี drafts/

จากนั้นรันคำสั่งต่อไปนี้:

 ./blip /path/to/your/blog/ -r

ข้อโต้แย้ง

-r สร้างทั้งไซต์ใหม่โดยการเผยแพร่ไฟล์ Markdown ทั้งหมดในไดเร็กทอรี drafts/

-w ดู drafts/ ไดเร็กทอรีของคุณสำหรับไฟล์ Markdown ใหม่และเผยแพร่โดยอัตโนมัติ

-i สร้างเฉพาะหน้า index*.html ใหม่เท่านั้น

-h แสดงความช่วยเหลือ

การพึ่งพาอาศัยกัน

• SwiftFSWatcher

เครื่องมือเฝ้าดูระบบไฟล์ที่ใช้งานง่าย / ขยายโดยใช้ Swift

• ลง

การเรนเดอร์ Markdown ที่รวดเร็วอย่างเห็นได้ชัดใน Swift สร้างขึ้นจาก cmark

ตัวอย่างสด

เยี่ยมชมเว็บไซต์ส่วนตัวของฉันเพื่อดูตัวอย่างการใช้งาน Blip