jupl / markdown-brunch

Compiles Markdown to HTML for brunch

markdown-brunch 1.7.1

Compiles Markdown files to HTML in brunch using Marked. Highlight.js support is included for syntax highlighting. Plugin checks for files that have one of the following extensions:

• .markdown
• .mdown
• .mkdn
• .md
• .mkd
• .mdwn
• .mdtxt
• .mdtext
• .text

It is important to note that this will only generate the necessary HTML. It is up to you to apply any additional CSS themes to make it more presentable. Visit the highlight.js test site for a list of default themes by Highlight.js.

Config

Marked's default configuration options can be overridden using config. For example:

marked:
  gfm: false
  smartypants: true

Syntax Highlighting

Code blocks by default do not get syntax highlighted.

```
No syntax highlighting here.
```

If a Highlight-supported language is identified in a fenced code block, it will get syntax highlighted.

```javascript
function add(x, y) {
  return x + y;
}
```

You can also use the auto identifier to use Highlight's language auto-detect feature.

```auto
* {
  box-sizing: border-box;
}
```

For a list of supported languages, visit the highlight.js test site.

Usage

Add "markdown-brunch": "x.y.z" to package.json of your brunch app.

Pick a plugin version that corresponds to your minor (y) brunch version.

If you want to use git version of plugin, add "markdown-brunch": "git+ssh://[email protected]:jupl/markdown-brunch.git".

markdown-brunch's Issues

Add Ability to Define Custom Wrapper in Config

yarn error

when using yarn dependency manager i get the following error:

error [email protected]: The engine "node" is incompatible with this module. Expected version "~0.6.10 || 0.8 || 0.9".

this does not happen when i use npm

Plugin does not appear to be doing anything

Hi,

I've installed markdown-brunch as per the instructions. I can see that the plugin has been installed, however when I do a brunch build the markdown file is not compiled.

Is there somewhere specific I need to put the file?

Where do the markdown files get compiled to? public/?

Do I need to make some change to config.coffee?

I have installed the plugin with the following entry in the dependencies section of plackage.json:

"markdown-brunch": ">= 1.0 < 1.6"

Marked Options

Use Brunch config.* to allow user to change Marked options.

Consider Using Another MD Library

Perhaps something like Marked?