Parsing Markdown containing HTML elements using remark.

.editorconfig

root = true

[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.js]
indent_style = tab

[*.py]
indent_style = space

[*.md]
indent_style = space
indent_size = 4
trim_trailing_whitespace = false

[package.json]
indent_style = space
indent_size = 2

.gitattributes

* text=auto

.gitignore

# Files #
#########


# Directories #
###############
reports/
build/

# Compiled source #
###################
*.com
*.class
*.dll
*.exe
*.o
*.so
*.slo
*.lo
*.obj
*.dylib
*.dll
*.lai
*.la
*.a
*.lib
*.ko
*.elf

# Precompiled headers #
#######################
*.gch
*.pch

# Executables #
###############
*.exe
*.out
*.app

# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip

# Logs and databases #
######################
*.log
*.sql
*.sqlite

# OS generated files #
######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
Icon?
ehthumbs.db
Thumbs.db
Desktop.ini

# Temporary files #
###################
*~

# Node.js #
###########
/node_modules/
pids
*.pid
*.seed

# Matlab #
##########
*.asv
*.mex*

# Fortran #
###########
*.mod

# R #
#####
.Rhistory
.Rapp.history
.Rproj.user/

# Python #
##########
__pycache__/
*.py[cod]
*$py.class

# TeX #
#######
*.aux
*.lof
*.log
*.lot
*.fls
*.out
*.toc
*.dvi
*-converted-to.*
*.bbl
*.bcf
*.blg
*-blx.aux
*-blx.bib
*.brf
*.run.xml
*.fdb_latexmk
*.synctex
*.synctex.gz
*.synctex.gz(busy)
*.pdfsync
*.alg
*.loa
acs-*.bib
*.thm
*.nav
*.snm
*.vrb
*.acn
*.acr
*.glg
*.glo
*.gls
*.brf
*-concordance.tex
*.tikz
*-tikzDictionary
*.idx
*.ilg
*.ind
*.ist

.jshintignore

# Directories #
###############
build/
reports/
dist/

# Node.js #
###########
/node_modules/

# Git #
#######
.git*

.jshintrc

{
	"bitwise": false,
	"camelcase": false,
	"curly": true,
	"eqeqeq": true,
	"es3": false,
	"forin": true,
	"freeze": true,
	"immed": true,
	"indent": 4,
	"latedef": "nofunc",
	"newcap": true,
	"noarg": true,
	"noempty": false,
	"nonbsp": true,
	"nonew": true,
	"plusplus": false,
	"quotmark": "single",
	"undef": true,
	"unused": true,
	"strict": true,
	"maxparams": 10,
	"maxdepth": 5,
	"maxstatements": 100,
	"maxcomplexity": false,
	"maxlen": 1000,
	"asi": false,
	"boss": false,
	"debug": false,
	"eqnull": false,
	"esnext": false,
	"evil": false,
	"expr": false,
	"funcscope": false,
	"globalstrict": false,
	"iterator": false,
	"lastsemic": false,
	"laxbreak": false,
	"laxcomma": false,
	"loopfunc": false,
	"maxerr": 1000,
	"moz": false,
	"multistr": false,
	"notypeof": false,
	"proto": false,
	"scripturl": false,
	"shadow": false,
	"sub": true,
	"supernew": false,
	"validthis": false,
	"noyield": false,
	"browser": true,
	"browserify": true,
	"couch": false,
	"devel": true,
	"dojo": false,
	"jasmine": false,
	"jquery": false,
	"mocha": true,
	"mootools": false,
	"node": true,
	"nonstandard": false,
	"prototypejs": false,
	"qunit": false,
	"rhino": false,
	"shelljs": false,
	"worker": false,
	"wsh": false,
	"yui": false,
	"globals": {}
}

README.md

remark

Parsing Markdown containing HTML elements using remark.

Installation

$ git clone https://gist.github.com/kgryte/ef5a5e5c093ef3344a288b1d126d9826
$ npm install

Usage

$ node ./example.js

Notes

• commonmark demo

  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE CommonMark SYSTEM "CommonMark.dtd">
  <document xmlns="http://commonmark.org/xml/1.0">
    <html_block>&lt;div&gt;
      &lt;img src=&quot;foo.png&quot; alt=&quot;foo&quot;&gt;
      &lt;br&gt;
  &lt;/div&gt;</html_block>
    <html_block>&lt;div&gt;</html_block>
    <code_block>&lt;img src=&quot;foo.png&quot; alt=&quot;foo&quot;&gt;
  
  &lt;br&gt;
  </code_block>
    <html_block>&lt;/div&gt;</html_block>
  </document>
  

---

License

MIT license.

Copyright

Copyright © 2016. Athan Reines.

ast.json

{
  "type": "root",
  "children": [
    {
      "type": "html",
      "value": "<div>\n    <img src=\"foo.png\" alt=\"foo\">\n    <br>\n</div>",
      "position": {
        "start": {
          "line": 2,
          "column": 1,
          "offset": 1
        },
        "end": {
          "line": 5,
          "column": 7,
          "offset": 56
        },
        "indent": [
          1,
          1,
          1
        ]
      }
    },
    {
      "type": "html",
      "value": "<div>",
      "position": {
        "start": {
          "line": 7,
          "column": 1,
          "offset": 58
        },
        "end": {
          "line": 7,
          "column": 6,
          "offset": 63
        },
        "indent": []
      }
    },
    {
      "type": "code",
      "lang": null,
      "value": "<img src=\"foo.png\" alt=\"foo\">\n\n<br>",
      "position": {
        "start": {
          "line": 9,
          "column": 1,
          "offset": 65
        },
        "end": {
          "line": 11,
          "column": 9,
          "offset": 108
        },
        "indent": [
          1,
          1
        ]
      }
    },
    {
      "type": "html",
      "value": "</div>",
      "position": {
        "start": {
          "line": 13,
          "column": 1,
          "offset": 110
        },
        "end": {
          "line": 13,
          "column": 7,
          "offset": 116
        },
        "indent": []
      }
    }
  ],
  "position": {
    "start": {
      "line": 1,
      "column": 1,
      "offset": 0
    },
    "end": {
      "line": 15,
      "column": 1,
      "offset": 118
    }
  }
}

attacher.js

'use strict';

// MODULES //

var transformer = require( './transformer.js' );


// ATTACHER //

/**
* Attach a plugin to a remark processor in order to compile Markdown to plain text.
*
* @param {Remark} remark - processor
* @param {Object} [options] - plugin options
* @return {Function} transformer
*/
function attacher() {
	return transformer;
} // end FUNCTION attacher()


// EXPORTS //

module.exports = attacher;

example.js

'use strict';

var fs = require( 'fs' );
var path = require( 'path' );
var remark = require( 'remark' );
var toPlainText = require( './../lib' );

var fpath;
var opts;
var file;
var doc;

// Load a Markdown file...
fpath = path.join( __dirname, 'fixtures/input.md' );
opts = {
	'encoding': 'utf8'
};
file = fs.readFileSync( fpath, opts );

// Process the Markdown file:
doc = remark.use( toPlainText ).process( file );

index.js

'use strict';

// MODULES //

var attacher = require( './attacher.js' );


// EXPORTS //

module.exports = attacher;

input.md

<img src="foo.png" alt="foo">

<br>

LICENSE

The MIT License (MIT)

Copyright (c) 2016 Athan Reines.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

package.json

{
  "name": "remark-html-aset",
  "version": "0.0.0",
  "description": "Parsing Markdown containing HTML elements with remark.",
  "author": {
    "name": "Athan Reines",
    "email": "[email protected]"
  },
  "contributors": [
    {
      "name": "Athan Reines",
      "email": "[email protected]"
    }
  ],
  "scripts": {},
  "main": "./lib",
  "repository": {
    "type": "git",
    "url": "https://gist.github.com/kgryte/ef5a5e5c093ef3344a288b1d126d9826"
  },
  "keywords": [],
  "dependencies": {
    "remark": "^4.2.2"
  },
  "devDependencies": {},
  "license": "MIT"
}

transformer.js

'use strict';

// MODULES //

var fs = require( 'fs' );
var path = require( 'path' );


// TRANSFORMER //

/**
* Transforms a Markdown file.
*
* @private
* @param {Node} ast - root node
* @param {File} file - virtual file
*/
function transformer( ast ) {
	var fpath;
	var opts;

	opts = {
		'encoding': 'utf8'
	};

	fpath = path.resolve( __dirname, '../examples/fixtures/ast.json' );

	fs.writeFileSync( fpath, JSON.stringify( ast ), opts );
} // end FUNCTION transformer()


// EXPORTS //

module.exports = transformer;