jdown

如果您要在Markdown中創建內容或使用輸出Markdown文件的CMS之類的CMS，則jDown可以將內容轉換為構建時間中包含HTML的JSON，並準備在模板中消耗。

安裝

$ npm install jdown --save-dev 

基本用法

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

致電JDown，使用您的降價內容的路徑（相對於項目根），它將您的內容轉換為JSON。

結構內容

JDown輸出的JSON結構取決於內容文件夾中的文件的結構。

？文件

將變成對象，文件對象將始終包含一個contents和fileInfo屬性...

文件夾中的文件

將變成單個對象，然後將其分組為具有與父文件夾相同名稱的父對象（不要深度深）。

？收藏

為了生成文件對象的數組，可以創建一個名為“集合”的文件夾。收集文件夾應僅包含子文件夾，然後每個文件夾中的每個文件都將添加到一個對像數組中。

文件內容

YAML FrontMatter可以包含在整個文件的頂部，並將其添加到生成的JSON中作為單個屬性。

 ---
title : Example frontmatter
---

Example Markdown Content

API

jdown（[路徑]，[選項]）

小路

類型： string
必需的

通往包含與上述指南的文件夾結構的文件夾的路徑。該路徑應相對於項目root，因此，如果您的內容在/Users/username/project/src/content中，則將使用jdown('src/content') 。

選項

類型： object

降價

類型： object

通過標記的選項，JDown支持所有可用的標記選項，這些選項可用於控制降價的解析。

資產

類型： object

資產解析選項。使用JDown進行解析資產是完全可選的，但帶有一些好處，包括：

• 能夠與Markdown Content一起組織資產
• 使用Imagemin自動縮小圖像文件
• 緩存破壞，使用資產的最後修改時間（mtime）更改其文件名，並避免使用的資產的舊版本

所有靜態資產都必須放置在/assets文件夾中。資產文件夾可以放置在頂級內容目錄和/或子目錄中。然後，可以使用![](./assets/my-asset.png)在Markdown Content Assets中，其中my-asset.png是放置在AN /assets文件夾中的資產。

資產選項對象可以包含以下屬性：

財產	類型	預設	描述
輸出	細繩	。/民眾	目錄jdown將將處理的資產輸出到
小路	細繩	/	公開可訪問的路徑jdown將預先預測輸出文件名
PNG	目的	不明確的	輸入成像符號的選項
JPG	目的	不明確的	進入成像emin-jpegtran的選項
SVG	目的	不明確的	進入ImageMin-Svgo的選項
GIF	目的	不明確的	進入ImageMin-Svgo的選項

私人

類型： boolean
默認值： true

將其設置為false以禁用Markdown解析，並僅收到包含MARKDOWN而不是HTML的結構化JSON。

FileInfo

類型： boolean
默認值： false

將其設置為true ，以在輸出JSON中包含文件信息對象，該輸出JSON包含文件路徑，名稱，在日期創建並在日期修改。

例子

此存儲庫的示例目錄包含JDown的使用，包括資產解析和自定義標記的渲染選項。

貢獻

歡迎任何拉的請求，並將對其進行審查。

執照

麻省理工學院