jdown jdown

jdown

หมวดหมู่อื่นๆ

v1.0.0

ดาวน์โหลด

หากคุณกำลังสร้างเนื้อหาใน Markdown หรือใช้ CMS เช่น NetLifyCms ซึ่งส่งออกไฟล์ markdown, JDown สามารถแปลงเนื้อหาเป็น JSON ที่มี HTML ในเวลาที่สร้างพร้อมที่จะบริโภคภายในเทมเพลต

ติดตั้ง

$ npm install jdown --save-dev

การใช้งานขั้นพื้นฐาน

 const jdown = require ( 'jdown' ) ;
jdown ( 'path/to/content' ) . then ( content => console . log ( content ) ) ;

โทรหา jdown ด้วยเส้นทางไปยังเนื้อหา markdown ของคุณ (สัมพันธ์กับรูทโครงการ) และจะแปลงเนื้อหาของคุณเป็น JSON

การจัดโครงสร้างเนื้อหา

โครงสร้างของ JSON ที่เอาต์พุต jdown ขึ้นอยู่กับว่าไฟล์ภายในโฟลเดอร์เนื้อหามีโครงสร้างอย่างไร

- ไฟล์

จะถูกเปลี่ยนเป็นวัตถุวัตถุไฟล์จะมี contents และคุณสมบัติ fileInfo เสมอ ...

ไฟล์ภายในโฟลเดอร์

จะถูกเปลี่ยนเป็นวัตถุแต่ละชิ้นจากนั้นจัดกลุ่มภายในวัตถุหลักที่มีชื่อเดียวกันกับโฟลเดอร์หลัก (อย่าไปลึกกว่าหนึ่งระดับ)

- ของสะสม

ในการสร้างอาร์เรย์ของวัตถุไฟล์สามารถสร้างโฟลเดอร์ "คอลเลกชัน" ได้ โฟลเดอร์คอลเลกชันควรมีโฟลเดอร์ย่อยเท่านั้นแต่ละไฟล์ภายในโฟลเดอร์ย่อยจะถูกเพิ่มลงในอาร์เรย์ของวัตถุ

เนื้อหาไฟล์

Yaml frontmatter สามารถรวมอยู่ที่ด้านบนของไฟล์ใด ๆ ตลอดและจะถูกเพิ่มลงใน JSON ที่สร้างขึ้นเป็นคุณสมบัติของแต่ละบุคคล

 ---
title : Example frontmatter
---

Example Markdown Content

API

jdown ([path], [ตัวเลือก])

เส้นทาง

ประเภท: string
ที่จำเป็น

พา ธ ไปยังโฟลเดอร์ที่มีไฟล์ markdown ที่มีโครงสร้างโฟลเดอร์ที่ตรงกับแนวทางข้างต้น เส้นทางควรสัมพันธ์กับรูทโครงการดังนั้นหากเนื้อหาของคุณอยู่ใน /Users/username/project/src/content คุณจะใช้ jdown('src/content')

ตัวเลือก

ประเภท: object

การทำเครื่องหมาย

ประเภท: object

ตัวเลือกในการส่งผ่านไปยังการทำเครื่องหมาย JDOWN รองรับตัวเลือกที่ทำเครื่องหมายไว้ทั้งหมดซึ่งสามารถใช้ในการควบคุมวิธีการแยกวิเคราะห์ของ markdown

สินทรัพย์

ประเภท: object

ตัวเลือกการแยกวิเคราะห์สินทรัพย์ การใช้ Jdown to Parse Assets เป็นทางเลือกอย่างสมบูรณ์ แต่มาพร้อมกับประโยชน์เล็กน้อยรวมถึง:

ความสามารถในการจัดระเบียบสินทรัพย์ควบคู่ไปกับเนื้อหา Markdown
minification อัตโนมัติของไฟล์รูปภาพโดยใช้ imagemin
แคชที่จับได้โดยใช้เวลาที่แก้ไขแล้ว (mtime) ของสินทรัพย์เพื่อเปลี่ยนชื่อไฟล์และหลีกเลี่ยงเวอร์ชันเก่าของสินทรัพย์ที่เสิร์ฟ

สินทรัพย์คงที่ทั้งหมดจะต้องวางไว้ภายในโฟลเดอร์ /assets โฟลเดอร์สินทรัพย์สามารถวางไว้ในไดเรกทอรีเนื้อหาระดับบนสุดและ/หรือไดเรกทอรีย่อย ภายในสินทรัพย์เนื้อหา markdown สามารถอ้างอิงได้โดยใช้ ![](./assets/my-asset.png) โดยที่ my-asset.png เป็นสินทรัพย์ที่อยู่ภายในโฟลเดอร์ AN /assets

วัตถุตัวเลือกสินทรัพย์สามารถมีคุณสมบัติต่อไปนี้:

คุณสมบัติ	พิมพ์	ค่าเริ่มต้น	คำอธิบาย
เอาท์พุท	สาย	./สาธารณะ	ไดเรกทอรี jdown จะส่งออกสินทรัพย์ที่ประมวลผลไปยัง
เส้นทาง	สาย	-	Path ที่สามารถเข้าถึงได้ในที่สาธารณะ JDown จะรวมไปถึงชื่อไฟล์เอาต์พุต
png	วัตถุ	ไม่ได้กำหนด	ตัวเลือกที่จะส่งผ่านไปยัง imagemin-pngquant
JPG	วัตถุ	ไม่ได้กำหนด	ตัวเลือกที่จะส่งผ่านไปยัง imagemin-jpegtran
SVG	วัตถุ	ไม่ได้กำหนด	ตัวเลือกที่จะส่งผ่านไปยัง imagemin-svgo
GIF	วัตถุ	ไม่ได้กำหนด	ตัวเลือกที่จะส่งผ่านไปยัง imagemin-svgo