markdown-it-fancy-lists - npm Package Compare versions

Comparing version 0.0.1-alpha1 to 1.0.0

esm/index.js

@@ -157,3 +157,3 @@ var __assign = (this && this.__assign) || function () {
     return previousMarker.isOrdered === currentMarker.isOrdered
-        && (previousMarker.type === currentMarker.type || previousMarker.type === "0" && currentMarker.type === "#")
+        && (previousMarker.type === currentMarker.type || currentMarker.type === "#")
         && previousMarker.delimiter === currentMarker.delimiter;
@@ -160,0 +160,0 @@ }

lib/index.js

@@ -160,3 +160,3 @@ "use strict";
     return previousMarker.isOrdered === currentMarker.isOrdered
-        && (previousMarker.type === currentMarker.type || previousMarker.type === "0" && currentMarker.type === "#")
+        && (previousMarker.type === currentMarker.type || currentMarker.type === "#")
         && previousMarker.delimiter === currentMarker.delimiter;
@@ -163,0 +163,0 @@ }

package.json

 {
 	"name": "markdown-it-fancy-lists",
-	"version": "0.0.1-alpha1",
+	"version": "1.0.0",
 	"description": "Extension for markdown-it to support additional numbering types for ordered lists ",
-	"keywords": [],
+	"keywords": [
+		"markdown-it-plugin",
+		"markdown-it",
+		"markdown",
+		"commonmark",
+		"fancy-lists",
+		"ordered-list"
+	],
 	"author": {
@@ -7,0 +14,0 @@ "name": "Moxio",

README.md

@@ -0,2 +1,131 @@
+[![NPM version](https://img.shields.io/npm/v/markdown-it-fancy-lists.svg?style=flat)](https://www.npmjs.org/package/markdown-it-fancy-lists)
+
 markdown-it-fancy-lists
 =======================
+
+Plugin for the [markdown-it](https://github.com/markdown-it/markdown-it)
+markdown parser.
+
+Uses unofficial markdown syntax based on the syntax supported by
+[Pandoc](https://pandoc.org/MANUAL.html#extension-fancy_lists).
+See the section [Syntax](#syntax) below for details.
+
+Installation
+------
+This library can be installed from the NPM package registry. Using NPM:
+```
+npm install markdown-it-fancy-lists
+```
+or Yarn
+```
+yarn add markdown-it-fancy-lists
+```
+
+Usage
+------
+ES module:
+```javascript
+import * as MarkdownIt from "markdown-it";
+import { markdownItFancyListPlugin } from "markdown-it-fancy-lists";
+
+const parser = new MarkdownIt("default");
+parser.use(markdownItFancyListPlugin);
+parser.render(/* markdown string */);
+```
+
+CommonJS:
+```javascript
+const MarkdownIt = require('markdown-it');
+const markdownItFancyListPlugin = require("markdown-it-fancy-lists").markdownItFancyListPlugin;
+
+const parser = new MarkdownIt("default");
+parser.use(markdownItFancyListPlugin);
+parser.render(/* markdown string */);
+```
+
+
+Syntax
+------
+The supported markdown syntax is based on the one used by
+[Pandoc](https://pandoc.org/MANUAL.html#extension-fancy_lists).
+
+A simple example:
+```markdown
+i. foo
+ii. bar
+iii. baz
+```
+The will yield HTML output like:
+```html
+<ol type="i">
+  <li>foo</li>
+  <li>bar</li>
+  <li>baz</li>
+</ol>
+```
+
+A more complex example:
+```markdown
+c. charlie
+#. delta
+   iv) subfour
+   #) subfive
+   #) subsix
+#. echo
+```
+
+A short description of the syntactical rules:
+
+* Apart from numbers, also letters (uppercase or lowercase) and
+  Roman numerals (uppercase or lowercase) can be used to number
+  ordered list items. Like lists marked with numbers, they need to
+  be followed by a single right-parenthesis or period.
+* Changing list marker types (also between uppercase and lowercase,
+  or the symbol after the 'number') starts a new list.
+* The numeral of the first item determines the numbering of the list.
+  If the first item is numbered "b", the next item will be numbered
+  "c", even if it is marked "z" in the source. This corresponds to
+  the normal `markdown-it` behavior for numeric lists, and
+  essentially also implements [Pandoc's `startnum` extension](https://pandoc.org/MANUAL.html#extension-fancy_lists).
+* If the first list item is numbered "I" or "i", the list is considered
+  to be numbered using Roman numerals, starting at 1. If the list
+  starts with another single letter that could be interpreted as a
+  Roman numeral, the list is numbered using letters: a first item
+  marked with "C." uses uppercase letters starting at 3, not Roman
+  numerals starting a 100.
+* In subsequent list items, such symbols can be used without any
+  ambiguity: in "B.", "C.", "D." the "C" is the letter "C"; in
+  "IC.", "C.", "CI." the "C" is a Roman 100.
+* A "#" may be used in place of any numeral to continue a list. If
+  the first item in a list is marked with "#", that list is numbered
+  "1", "2", "3", etc.
+* A list marker consisting of a single uppercase letter followed by
+  a period (including Roman numerals like "I." or "V.") needs to be
+  followed by at least two spaces ([rationale](https://pandoc.org/MANUAL.html#fn1)).
+
+All of the above are entirely compatible with how Pandoc works. There
+are two small differences with Pandoc's syntax:
+
+* This plugin does not support list numbers enclosed in parentheses,
+  as the Commonmark spec does not support these either for lists
+  numbered with Arabic numerals.
+* Pandoc does not allow any list to interrupt a paragraph. In the
+  spirit of the Commonmark spec (which allows only lists starting
+  with 1 to interrupt a paragraph), this plugins allows lists that
+  start with "A", "a", "I" or "i" (i.e. all 'first numerals') to
+  interrupt a paragraph. The same holds for the "#" generic numbered
+  list item marker.
+
+Versioning
+----------
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+Contributing
+------------
+Contributions to this project are more than welcome. When reporting an issue,
+please include the input to reproduce the issue, along with the expected
+output. When submitting a PR, please include tests with your changes.
+
+License
+-------
+This project is released under the MIT license.

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

36518

increased by13.64%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

132

increased by4300%

No dependency changes