Skip to content
Interpret mmd fenced code blocks in a markdown file and generate a cooler version of it.
JavaScript
Branch: master
Clone or download
Latest commit 891557a Nov 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode 🎉 setup works Apr 26, 2018
ReadmeSrc fix readme May 22, 2018
src remove unused property Jun 15, 2018
.eslintrc add eslint Jun 15, 2018
.gitignore 🛠 change default path Apr 26, 2018
.prettierrc 🎉 init Apr 21, 2018
Readme.md
index.js
package.json v1.0.0 Apr 26, 2018
yarn.lock v0.1.2 Apr 26, 2018

Readme.md

mmarkdown

Codacy Badge

Markdown on caffeine ☕️

Interpret mmd fenced code blocks in a markdown file and generate a cooler version of it.

mmd fenced code block

output:

Hello Jessie

Table of Contents

Demo / Boilerplate / Real world case

The file you are reading right now is generated from this file.

For a kind of boilerplate repo instead, have a look at this repo.

🌎MicheleBertoli/css-in-js

🌎streamich/cross-ci

Install

yarn add mmarkdown --dev

Config package.json (defaults)

{
    "mmarkdown": {
      "src": "./Readme/Readme.md",
      "out": "./Readme.md",
      "scripts": "./Readme/Readme.js",
      "backup": "true",
      "backupPath": "./Readme/backup/"
    }
}
{
  "scripts":{
    "make-readme": "mmarkdown"
  }
}

Command line arguments

argument description default
src Source md file ./ReadmeSrc/Readme.md
out Output md file ./Readme.md
scripts Helper JS file ./ReadmeSrc/Readme.js
backup Do a backup of the output file false
backupPath backup path ./ReadmeSrc/backup/
help Show help
version Show version number
{
  "scripts":{
    "make-readme": "mmarkdown --backup --backupPath ./backupReadme/"
  }
}

Usage

Mmarkdown takes a plain markdown file and generates a copy of it.

It starts to be less boring when you add fenced code blocks with the language identifier set to mmd.

Everything that is returned (as a string) from the code in a block will be interpreted and replaced to the block in the output file.

It's full async, which is cool, lots of awaits are waiting for you there but soon enough you will face a problem: too much code to write in a markdown file! Terrible experience!

The solution in mmarkdown is in the scripts option. The module that the scripts file returns will be passed to the context of the fenced block, see example 3.

The backup option, false by default, will make a copy of the current output file, postfix it with a timestamp and move it into backupPath.

Example 1

mmd fenced code block:

const hello = message => {
  return message
}

return hello('### hippieeeeee hippie yeeeee!!!!!!!!')

output:

hippieeeeee hippie yeeeee!!!!!!!!

Example 2

mmd fenced code block:

const array = [1, 3, 5]

return array.map(item => '#### ' + item).join('\n\n')

output:

1

3

5

Example 3, with Scripts

this script file is passed to mmarkdown with the scripts option:

module.exports = {
  processMyArray: async array =>
    new Promise(resolve => {
      setTimeout(() => {
        resolve(
          array.map(item => ({
            name: item + ' async'
          }))
        )
      }, 1000)
    })
}

mmd fenced code block:

//scripts is passed

const array = [1, 3, 5]

const something = await scripts.processMyArray(array)

const myFinalString = something.map(item => '#### ' + item.name)
  .join('\n\n')

return myFinalString

output:

1 async

3 async

5 async

(The setTimeout is there just for demo purposes)

Maintainers

@albinotonnina

Contribute

PRs accepted.

License

MIT © 2018 Albino Tonnina

You can’t perform that action at this time.