Skip to content

将 Markdown 格式的文章(.md)后缀,提取元数据,并使用 Markdown-it 将文章内容转化为 Html,最后输出为 json 文件。

License

Notifications You must be signed in to change notification settings

dmscode/markdown-posts-to-json

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown posts to JSON

本插件主要功能是将 Markdown 文档头部的 YAML 格式数据进行提取,其余部分作为文章内容转化为 HTML 格式,并将上述内容转换为 JSON 格式输出。

主要是为了满足对博客文章的处理需求。

同时会生成一个索引文件(JSON),内容为一个包含所有文章元数据(文章头部 YAML 格式部分)内容的对象。对象结构与目录结构相同,并支持将 index.md 文件的元数据合并至它所在目录的对象中

使用方法:

本插件需配合 Webpack 服用,只需在 Webpack 配置文件中如下配置即可,对于 Markdown-It 的配置,可在 md 属性中进行配置,md 属性必须存在,最简设置为:new MarkdownIt()。其他选项均非必须(但估计你不会喜欢我的默认值)。

如果需要代码高亮(按如下配置即可实现),需在页面中自行引入 highlight.js 的样式表,例如:import 'highlight.js/styles/atom-one-dark.css'

Webpack 配置

  const hljs = require("highlight.js")
  const MarkdownIt = require("markdown-it")

  ...

    plugins: [
    // Markdown posts 2 json data
    new mp2j({
      // input path, your posts path
      postPath: path.resolve(__dirname, './posts'),
      // output path
      outPath: 'dist/posts',
      // include sub dir
      includeSubPath: true,
      // name for index of JSON
      indexName: 'index',
      // merge index.md's metadatas to its dir
      mergeIndex2dir: true,
      // sub Node's name
      subNode: 'posts',
      // all prefix is 'mi_' keys will be remove prefix and transfered to Markdown-it. This is default option of Markdown-It
      md: new MarkdownIt({
        html: false,
        xhtmlOut: false,
        breaks: false,
        langPrefix: 'language-',
        linkify: false,
        typographer: false,
        quotes: '“”‘’',
        highlight: function (str, lang) {
          if (lang && hljs.getLanguage(lang)) {
            try {
              return '<pre class="hljs"><code>' +
                    hljs.highlight(lang, str, true).value +
                    '</code></pre>';
            } catch (__) {}
          }
          return '<pre class="hljs"><code>' + mp2j.options.md.utils.escapeHtml(str) + '</code></pre>';
        }
      })
    })
  ]

更新日志:

0.0.9

支持使用 parent 设置父节点,支持多个根节点。

0.0.8

修改依赖引入位置,以及 Markdwon-It 选项传入方式,现在可正常实现代码高亮(需自行引入 highlight.js 的样式表)

0.0.7

文章数据分割正则优化

0.0.6

修正索引文件层级问题,可以设置索引文件中子节点的名称

0.0.5

分割正则优化

0.0.4

包信息完善

0.0.3

优化索引文件结构

0.0.2

实现了 Markdown-it 的参数传入

0.0.1

功能初步实现

About

将 Markdown 格式的文章(.md)后缀,提取元数据,并使用 Markdown-it 将文章内容转化为 Html,最后输出为 json 文件。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published