Support simple yaml metadata

Author: ksw2000

lib/container.ts

@@ -1,11 +1,11 @@
 // modified from https://github.com/markdown-it/markdown-it-container
 
 const names = ['success', 'info', 'warning', 'danger', 'spoiler']
-export function MarkdownItContainer (md: any, _options: any) {
+export function MarkdownItContainer(md: any, _options: any) {
   // Second param may be useful if you decide
   // to increase minimal allowed marker length
 
-  function renderContainer (tokens: any, idx: number, _options: any, env: any, slf: any): string {
+  function renderContainer(tokens: any, idx: number, _options: any, env: any, slf: any): string {
     // add a class to the opening tag
     if (tokens[idx].nesting === 1) {
       tokens[idx].attrJoin('class', tokens[idx].name)
@@ -14,7 +14,7 @@ export function MarkdownItContainer (md: any, _options: any) {
     return slf.renderToken(tokens, idx, _options, env, slf)
   }
 
-  function renderSpoiler (tokens: any, idx: number, _options: any, env: any, slf: any): string {
+  function renderSpoiler(tokens: any, idx: number, _options: any, env: any, slf: any): string {
     // add a class to the opening tag
     if (tokens[idx].nesting === 1) {
       let summary: string = tokens[idx].summary
@@ -34,7 +34,7 @@ export function MarkdownItContainer (md: any, _options: any) {
   const markerChar = markerStr.charCodeAt(0)
   const markerLen = markerStr.length
 
-  function rule (state: any, startLine: number, endLine: number, silent: any): boolean {
+  function rule(state: any, startLine: number, endLine: number, silent: any): boolean {
     let pos, nextLine, token
 
     let autoClosed = false

lib/converter.ts

@@ -19,17 +19,20 @@ const MarkdownItTOC = require('markdown-it-table-of-contents')
 const MarkdownItAnchor = require('markdown-it-anchor')
 const MarkdownItRuby = require('markdown-it-ruby')
 const MarkdownItCheckbox = require('markdown-it-checkbox')
+const htmlEncode = require('htmlencode').htmlEncode;
 
 export class Convert {
   src: Array<string>
   dest: string
   layout: string
   md: any
+  title: string
 
-  constructor (src: Array<string>, dest: string, layout: string, hardBreak: boolean) {
+  constructor(src: Array<string>, dest: string, layout: string, hardBreak: boolean) {
     this.src = src
     this.dest = dest
     this.layout = layout
+    this.title = ''
 
     // https://hackmd.io/c/codimd-documentation/%2F%40codimd%2Fmarkdown-syntax
     this.md = new MarkdownIt({
@@ -39,7 +42,11 @@ export class Convert {
       typographer: true
     })
       .use(MarkdownItMathJax())
-      .use(MarkdownItYAMLMetadata)
+      .use(MarkdownItYAMLMetadata, (option: any) => {
+        if ('title' in option) {
+          this.title = option.title as string
+        }
+      })
       .use(MarkdownItSub)
       .use(MarkdownItSup)
       .use(MarkdownItFootnote)
@@ -63,10 +70,10 @@ export class Convert {
 
   // @param html: html string
   // @return: html string with layout
-  private addLayout (html: string): string {
+  private addLayout(title: string, html: string): string {
     if (fs.existsSync(this.layout)) {
       const layout = fs.readFileSync(this.layout, { encoding: 'utf-8' })
-      return layout.replace('{{main}}', html)
+      return layout.replace('{{title}}', htmlEncode(title)).replace('{{main}}', html)
     }
 
     console.error(`${this.layout} is not found`)
@@ -75,19 +82,15 @@ export class Convert {
 
   // @param filepath: the path of the file should be converted
   // this function doesn't check the ext name of filepath
-  public convertFile (filepath: string) {
+  public convertFile(filepath: string) {
     const markdown = fs.readFileSync(filepath, { encoding: 'utf-8' })
-    // process yaml metadata
-    // if (markdown.slice(0, 3) === '---') {
-    //   markdown = '<!--yaml-metadata-->' + markdown
-    // }
     const html = this.md.render(markdown)
-    const res = this.addLayout(html)
+    const res = this.addLayout(this.title, html)
     const basename = path.basename(filepath)
     fs.writeFileSync(path.join(this.dest, basename.replace(/\.md$/, '.html')), res)
   }
 
-  public convertBatch () {
+  public convertBatch() {
     if (!fs.existsSync(this.dest)) {
       fs.mkdirSync(this.dest)
     }

lib/yaml-metadata.ts

@@ -1,14 +1,16 @@
+import YAML from 'yaml'
+
 // modified from https://github.com/flaviotordini/markdown-it-yaml
 const tokenType = 'yaml_metadata'
 
-export function MarkdownItYAMLMetadata (md: any, _options: any) {
-  function getLine (state: any, line: any): string {
+export function MarkdownItYAMLMetadata(md: any, callback: undefined | ((option: any) => any)) {
+  function getLine(state: any, line: any): string {
     const pos = state.bMarks[line]
     const max = state.eMarks[line]
     return state.src.substring(pos, max)
   }
 
-  function rule (state: any, startLine: number, endLine: number, silent: any): boolean {
+  function rule(state: any, startLine: number, endLine: number, silent: any): boolean {
     if (state.blkIndent !== 0 || state.tShift[startLine] < 0) {
       return false
     }
@@ -38,18 +40,20 @@ export function MarkdownItYAMLMetadata (md: any, _options: any) {
 
     const dataStartPos = state.bMarks[dataStart]
     const dataEndPos = state.eMarks[dataEnd]
-    const yaml = state.src.substring(dataStartPos, dataEndPos)
 
     const token = state.push(tokenType, '', 0)
-    token.content = yaml
+    token.yaml = state.src.substring(dataStartPos, dataEndPos)
 
     state.line = nextLine + 1
     return true
   }
 
-  function renderer (tokens: any, idx: number, _options: any, _evn: any): string {
+  function renderer(tokens: any, idx: number, _options: any, _evn: any): string {
     const token = tokens[idx]
-    return `<!--yaml\n${token.content}\n-->`
+    if (callback) {
+      callback(YAML.parse(token.yaml))
+    }
+    return `<!--yaml\n${token.yaml}\n-->`
   }
 
   md.block.ruler.before('hr', tokenType, rule)

package-lock.json

@@ -29,6 +29,7 @@
     "@gerhobbelt/markdown-it-checkbox": "^1.2.0-3",
     "@types/node": "^16.11.11",
     "commander": "^8.3.0",
+    "htmlencode": "^0.0.4",
     "markdown-it": "^12.2.0",
     "markdown-it-abbr": "^1.0.4",
     "markdown-it-anchor": "^8.4.1",
@@ -45,7 +46,8 @@
     "markdown-it-sup": "^1.0.0",
     "markdown-it-table-of-contents": "^0.6.0",
     "markdown-it-yaml": "^1.0.0",
-    "typescript": "^4.5.2"
+    "typescript": "^4.5.2",
+    "yaml": "^2.2.1"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.50.0",