jdown

Если вы создаете контент в Markdown или используете CMS, такие как NetLifyCMS, который выводит файлы маркировки, JDOWN может преобразовать контент в JSON, содержащий HTML во время сборки, готовые к употреблению в шаблонах.

Установить

$ npm install jdown --save-dev 

Основное использование

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

Позвоните в Jdown с путем к контенту Marckdown (по сравнению с корнем проекта), и он преобразует ваш контент в JSON.

Структурирование контента

Структура JSON, который вывод JDONE зависит от того, как структурированы файлы в папке содержимого.

? Файлы

Будет превращено в объект, объекты файлов всегда будут содержать contents и свойство fileInfo ...

Файлы в папках

Будет превращен в отдельные объекты, а затем сгруппированы в родительский объект, который имеет то же имя, что и родительская папка (не проходите более одного уровня глубиной).

? Коллекции

Чтобы сгенерировать массивы объектов файла, может быть создана папка с именем «Коллекции». В папке Collections должна содержаться только под папки, каждый тогда каждый файл в подпапке будет добавлен в массив объектов.

Содержание файла

Frontmatter YAML может быть включена в верхней части любых файлов повсюду, и он будет добавлен в генерируемый JSON в качестве отдельных свойств.

 ---
title : Example frontmatter
---

Example Markdown Content

API

jdown ([path], [опции])

путь

Тип: string
Необходимый

Путь к папке, содержащей файлы разметки со структурой папок, которая соответствует вышеуказанным рекомендациям. Путь должен быть относительно root проекта, поэтому, если ваш контент был в /Users/username/project/src/content , вы бы использовали jdown('src/content') .

параметры

Тип: object

отметка

Тип: object

Варианты для перехода на маркировку, Jdown поддерживает все доступные отмеченные варианты, которые можно использовать для контроля того, как маркировка проанализирована.

ресурсы

Тип: object

Варианты анализа активов. Использование Jdown для анализа активов является совершенно необязательным, но поставляется с несколькими преимуществами, включая:

• Возможность организовать активы наряду с содержанием маркировки
• Автоматическое минимификация файлов изображений с использованием Imagemin
• Разбивание кэша, используя последнее измененное время (mtime) актива, чтобы изменить имя его файла и избежать старой версии обслуживаемого актива.

Все статические активы должны быть размещены в папках /assets . Папки активов могут быть размещены в каталоге контента верхнего уровня и/или его под каталогами. В рамках my-asset.png содержимого уценки можно ссылаться /assets помощью ![](./assets/my-asset.png)

Объект параметров активов может содержать следующие свойства:

Свойство	Тип	По умолчанию	Описание
выход	нить	./public	Каталог jdown выведет обработанные активы в
путь	нить	/	Общедоступный путь jdow
пнн	объект	неопределенный	Варианты перейти в Imagemin-Pngquant
JPG	объект	неопределенный	Варианты перехода в Imagemin-Jpegtran
Svg	объект	неопределенный	Варианты перехода в Imagemin-svgo
гифка	объект	неопределенный	Варианты перехода в Imagemin-svgo

parsemd

Тип: boolean
По умолчанию: true

Установите это на false , чтобы отключить анализ маркировки и просто получить структурированный JSON, содержащий Markdown, вместо HTML.

FileInfo

Тип: boolean
По умолчанию: false

Установите это в true чтобы включить объекты информации о файле в вывод JSON, который содержит путь к файлам, имя, созданную на дату и модифицированную на дату.

Примеры

Пример каталога этого репозитория содержит использование Jdown, включая анализ активов и пользовательские варианты рендеринга.

Внося

Любые запросы на привлечение приветствуются и будут рассмотрены.

Лицензия

Грань