@aeroware/outline - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/index.js

@@ -24,1 +24,12 @@ "use strict";
 exports.default = parseOutline;
+console.log(parseOutline(`h2 Welcome to Outline!
+
+h5 Outline is a subset of Jade
+
+p It's very easy to write outlines and documentation.
+
+p.wow You can add a class,
+
+p.amazing.wow or multiple classes.
+
+h4.amazing.wow#cool Even ids work as well.`));

package.json

 {
     "name": "@aeroware/outline",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

 # Outline
+
+Outline is a light-weight package for parsing Outline.
+
+Outline is our own subset of Jade, so there's nothing special about it.
+
+Example:
+
+```
+h2 Welcome to Outline!
+
+h5 Outline is a subset of Jade
+
+p It's very easy to write outlines and documentation.
+
+p.wow You can add a class,
+
+p.amazing.wow or multiple classes.
+
+h4.amazing.wow#cool Even ids work as well.
+```
+
+Output:
+
+```html
+<h2>Welcome to Outline!</h2>
+
+<h5>Outline is a subset of Jade</h5>
+
+<p>It's very easy to write outlines and documentation.</p>
+
+<p class="wow">You can add a class,</p>
+
+<p class="amazing wow">or multiple classes.</p>
+
+<h4 class="amazing wow" id="cool">Even ids work as well.</h4>
+```
+
+Simply import the package and call the function on a string. That's it!

src/index.ts

@@ -32,1 +32,15 @@ export default function parseOutline(outline: string) {
 }
+
+console.log(
+    parseOutline(`h2 Welcome to Outline!
+
+h5 Outline is a subset of Jade
+
+p It's very easy to write outlines and documentation.
+
+p.wow You can add a class,
+
+p.amazing.wow or multiple classes.
+
+h4.amazing.wow#cool Even ids work as well.`)
+);

No alert changes

Improved metrics

Total package byte prevSize

4283

40.93%

Lines of code

82

20.59%

Number of lines in readme file

40

1900%

No dependency changes