jdown

Wenn Sie Inhalte in Markdown erstellen oder ein CMS wie NetlifyCMS verwenden, das Markdown -Dateien ausgibt, kann Jdown den Inhalt in JSON umwandeln, das HTML zum Bauzeit enthält, und bereit, in Vorlagen konsumiert zu werden.

Installieren

$ npm install jdown --save-dev 

Grundnutzung

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

Rufen Sie Jdown mit dem Pfad zu Ihrem Markdown -Inhalt (relativ zum Projektroot) an und wandelt Ihren Inhalt in JSON um.

Strukturinhalt

Die Struktur des JSON, die Jdown ausgibt, hängt davon ab, wie Dateien im Inhaltsordner strukturiert sind.

? Dateien

Wird in ein Objekt umgewandelt, Dateiobjekte enthalten immer eine contents und fileInfo -Eigenschaft ...

Dateien in Ordnern

Wird in einzelne Objekte verwandelt und dann in einem übergeordneten Objekt gruppiert, das denselben Namen wie der übergeordnete Ordner hat (nicht mehr als eine Ebene tief gehen).

? Sammlungen

Um Arrays von Dateiobjekten zu generieren, kann ein Ordner mit dem Namen "Sammlungen" erstellt werden. Der Sammlungsordner sollte nur Subordner enthalten, jeweils jede Datei in einem Subordner zu einem Array von Objekten hinzugefügt.

Dateiinhalte

YAML Frontmatter kann ganz oben in allen Dateien aufgenommen werden und wird dem generierten JSON als individuelle Eigenschaften hinzugefügt.

 ---
title : Example frontmatter
---

Example Markdown Content

API

Jdown ([Path], [Optionen])

Weg

Typ: string
Erforderlich

Pfad zu einem Ordner mit Markdown -Dateien mit einer Ordnerstruktur, die den obigen Richtlinien entspricht. Der Pfad sollte relativ zum Projektrouch sein. Wenn Ihr Inhalt also in /Users/username/project/src/content war, würden Sie jdown('src/content') verwenden.

Optionen

Typ: object

Markdown

Typ: object

Die Optionen, die an markiert werden können, unterstützt alle verfügbaren markierten Optionen, mit denen der Markdown analysiert wird.

Vermögenswerte

Typ: object

Asset Parsing -Optionen. Die Verwendung von Jdown zur Analyse von Vermögenswerten ist völlig optional, bietet jedoch einige Vorteile, darunter:

• Fähigkeit, Assets zusammen mit Markdown -Inhalten zu organisieren
• Automatische Minifikation von Bilddateien mithilfe von Imagemin
• Cache Busting unter Verwendung der letzten modifizierten Zeit (Mime) des Vermögenswerts, um seinen Dateinamen zu ändern und die alte Version des Assets zu vermeiden, der bedient wird

Alle statischen Vermögenswerte müssen in Ordner /assets platziert werden. Assets -Ordner können in das Inhaltsverzeichnis auf höchstem Niveau und/oder die Subverzeichnisse platziert werden. Innerhalb des Markdown-Inhaltsvermögens können dann mit ![](./assets/my-asset.png) verwiesen werden, wobei my-asset.png ein Vermögenswert in einem /assets -Ordner ist.

Das Objekt der Assets Options kann die folgenden Eigenschaften enthalten:

Eigentum	Typ	Standard	Beschreibung
Ausgabe	Saite	./öffentlich	Verzeichnis Jdown wird verarbeitete Vermögenswerte an ausgeben
Weg	Saite	/	Der öffentlich zugängliche Pfad Jdown bereitet sich auf die Ausgabedateinamen vor
png	Objekt	undefiniert	Optionen, um im Imagemin-pngquant zu gelangen
JPG	Objekt	undefiniert	Optionen, um im Imagemin-Jpegtran zu gelangen
Svg	Objekt	undefiniert	Optionen, um im Imagemin-Svgo zu gelangen
GIF	Objekt	undefiniert	Optionen, um im Imagemin-Svgo zu gelangen

Parsemd

Typ: boolean
Standard: true

Stellen Sie dies auf false ein, um das Parsen von Markdown zu deaktivieren und nur strukturierte JSON zu erhalten, das Markdown anstelle von HTML enthält.

DateiInfo

Typ: boolean
Standard: false

Legen Sie dies auf true um Dateiinfo -Objekte in den Ausgang JSON aufzunehmen, der den zum Zeitpunkt erstellten Dateienpfad enthält, der zum Datum erstellt und zum Zeitpunkt geändert wird.

Beispiele

Das Beispielverzeichnis dieses Repositorys enthält die Verwendung von JDown einschließlich Asset Parsing und benutzerdefinierte markierte Renderoptionen.

Beitragen

Alle Pull -Anfragen sind willkommen und werden überprüft.

Lizenz

MIT