Плагин webpack для автоматического извлечения содержимого yaml из файла уценки.
Почему
Этот плагин позволяет людям писать markdown
с помощью YAML
, а затем извлекать содержимое YAML
в файл .json
.
Более того, в режиме --watch
или webpack-dev-server
будут обнаружены все изменения внутри указанного каталога (добавление, изменение и удаление), и новый контент будет автоматически записан в файл .json
.
Установить
Пряжа:
yarn add extract-yaml-from-markdown-plugin.js --dev
NPM:
npm install extract-yaml-from-markdown-plugin.js --save-dev
использование
Войдите в свой webpack.config.js
, требуйте extract-yaml-from-markdown-plugin.js
, затем запустите его в опции plugins
.
// webpack.config.js const { resolve } = require('path') const extractYamlFromMarkdownPlugin = require('extract-yaml-from-markdown-plugin.js') module.exports = { plugins: [ new extractYamlFromMarkdownPlugin({ mdDir: resolve(__dirname, './your-markdown-directory'), output: resolve(__dirname, './output-path-of-you-want') }) ] }
Опции
mdDir
{Строка}:- Каталог ваших файлов уценки. После определения плагин будет следить за этим каталогом. Как только вы
add
/update
/delete
один файл уценки, плагин обновит информацию YAML, а затем запишет их в.json
файл. output
{Строка}:- Плагин будет извлекать информацию YAML из данного файла уценки, а затем записывать их в файл
.json
по пути, который вы указали какoutput
. exclude
{Массив}:- Массив regEx, о котором вы не хотите, чтобы плагин заботился.
format
{Номер}:- Плагин, использующий метод
JSON.stringify()
для преобразования объекта в строку.format
будет последним параметром этого метода.
Контрольная работа
git clone https://github.com/jrainlau/extract-yaml-from-markdown-plugin.git
cd extract-yaml-from-markdown-plugin && yarn
# using `webpack` command yarn test
# using `webpack --watch` command yarn test:watch
# using `webpack-dev-server` command yarn test:dev-server
Перейдите в каталог /example
, чтобы узнать, что у вас есть.
Лицензия
Массачусетский технологический институт