remark-custom-blocks - npm Package Compare versions

Comparing version 2.4.1 to 2.4.2

package.json

		{
		"name": "remark-custom-blocks",
		"version": "2.4.1",
		"version": "2.4.2",
		"repository": {
		@@ -37,3 +37,3 @@ "url": "https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-custom-blocks",
		},
		"gitHead": "41ba346f4cb8a52f3ca658c7c217f578cbfca661"
		"gitHead": "b05f25a9f9f7be3c2987fb3c07f48cc1b43ca2aa"
		}

README.md

		@@ -18,2 +18,44 @@ # remark-custom-blocks [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status]

		## AST nodes (see [mdast][mdast] specification)

		By default, the plugin will produce the following two nodes, where `whatnot` is the name of you block:

		```javascript
		interface whatnotCustomBlock <: Parent {
		type: "whatnotCustomBlock";
		data: {
		hName: "div" or "details";
		hProperties: {
		className: [string];
		}
		}
		}
		```

		```javascript
		interface whatnotCustomBlockBody <: Parent {
		type: "whatnotCustomBlockBody";
		data: {
		hName: "div";
		hProperties: {
		className: [string];
		}
		}
		}
		```

		If your block has a heading, the following node will also be produced:

		```javascript
		interface whatnotCustomBlockHeading <: Parent {
		type: "whatnotCustomBlockHeading";
		data: {
		hName: "div" or "summary";
		hProperties: {
		className: [string];
		}
		}
		}
		```

		## Installation
		@@ -105,3 +147,3 @@

		* `fooCustomBlock`, content will be in `fooCustomBlockBlody`
		* `fooCustomBlock`, content will be in `fooCustomBlockBody`
		* `barCustomBlock`, content in `barCustomBlockBody`, optional title in `barCustomBlockHeading`
		@@ -108,0 +150,0 @@ * `quxCustomBlock`, content in `quxCustomBlockBody`, required title in `quxCustomBlockHeading`

New alerts