Unduh jdown - Unduh Kode Sumber jdown

jdown

Kategori lainnya

v1.0.0

Unduh

Jika Anda membuat konten dalam penurunan harga atau menggunakan CMS seperti NetlifyCMS yang mengeluarkan file penurunan mobil, JDown dapat mengubah konten menjadi JSON yang berisi HTML pada waktu pembuatan, siap untuk dikonsumsi dalam templat.

Memasang

$ npm install jdown --save-dev

Penggunaan dasar

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

Hubungi JDown dengan jalur ke konten penurunan harga Anda (relatif terhadap root proyek) dan itu akan mengonversi konten Anda ke JSON.

Penataan konten

Struktur JSON yang output JDOWN tergantung pada bagaimana file dalam folder konten disusun.

? File

Akan diubah menjadi objek, objek file akan selalu berisi contents dan properti fileInfo ...

File dalam folder

Akan diubah menjadi objek individual kemudian dikelompokkan dalam objek induk yang memiliki nama yang sama dengan folder induk (jangan melangkah lebih dari satu tingkat dalam).

? Koleksi

Untuk menghasilkan array objek file, folder bernama "koleksi" dapat dibuat. Folder koleksi hanya boleh berisi sub folder, masing -masing kemudian setiap file dalam sub folder akan ditambahkan ke array objek.

Konten file

Frontmatter YAML dapat dimasukkan di bagian atas file apa pun di seluruh dan akan ditambahkan ke JSON yang dihasilkan sebagai properti individual.

 ---
title : Example frontmatter
---

Example Markdown Content

API

JDown ([Path], [Opsi])

jalur

Ketik: string
Diperlukan

Jalur ke folder yang berisi file -file markdown dengan struktur folder yang cocok dengan pedoman di atas. Path harus relatif terhadap root proyek jadi jika konten Anda ada di /Users/username/project/src/content , Anda akan menggunakan jdown('src/content') .

opsi

Jenis: object

penurunan harga

Jenis: object

Opsi untuk ditandai, JDown mendukung semua opsi bertanda yang tersedia yang dapat digunakan untuk mengontrol bagaimana penurunan harga diuraikan.

aktiva

Jenis: object

Opsi penguraian aset. Menggunakan JDOW untuk parse aset benar -benar opsional, tetapi dilengkapi dengan beberapa manfaat termasuk:

Kemampuan untuk mengatur aset di samping konten penurunan harga
Minifikasi Otomatis File Gambar Menggunakan Imagemin
Cache Buste, menggunakan waktu yang dimodifikasi terakhir (mTime) dari aset untuk mengubah nama file dan menghindari versi lama aset yang dilayani

Semua aset statis harus ditempatkan di dalam /assets . Folder aset dapat ditempatkan di direktori konten tingkat atas dan/atau sub direktori. Dalam markdown konten aset kemudian dapat dirujuk menggunakan ![](./assets/my-asset.png) di mana my-asset.png adalah aset yang ditempatkan di dalam folder /assets .

Objek Opsi Aset dapat berisi properti berikut:

Milik	Jenis	Bawaan	Keterangan
keluaran	rangkaian	./publik	Direktori jDown akan menghasilkan aset yang diproses ke
jalur	rangkaian	/	Jalur yang dapat diakses secara publik JDown akan diatur dengan nama file output
png	obyek	belum diartikan	Opsi untuk masuk ke Imagemin-pngquant
jpg	obyek	belum diartikan	Opsi untuk masuk ke Imagemin-jpegtran
SVG	obyek	belum diartikan	Opsi untuk masuk ke Imagemin-SVGO
gif	obyek	belum diartikan	Opsi untuk masuk ke Imagemin-SVGO

parsemd

Jenis: boolean
Default: true

Atur ini ke false untuk menonaktifkan penguraian penurunan harga dan hanya menerima JSON terstruktur yang mengandung markdown alih -alih HTML.

fileInfo

Jenis: boolean
Default: false

Setel ini ke true untuk menyertakan objek info file dalam output JSON yang berisi jalur file, nama, dibuat pada tanggal dan dimodifikasi pada tanggal.