From df4d0a0b7e9cafb5c944c4fb95232d7c178a76c9 Mon Sep 17 00:00:00 2001 From: Thomas Hunter II Date: Sun, 16 Jul 2017 21:15:20 +0200 Subject: [PATCH] Fixing Markdown rendering on NPM site I believe the double hash headings immediately following an HTML line is causing the NPM page to render improperly (using the inspector we can see the anchor and the ## heading in the same paragraph tag). You can see the erroneous rendering here: https://www.npmjs.com/package/msgpack5 --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 2c9e67e..ce33fde 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,7 @@ API --- + ## API * msgpack() @@ -97,6 +98,7 @@ API ------------------------------------------------------- + ### msgpack(options(obj)) Creates a new instance on which you can register new types for being @@ -109,12 +111,14 @@ options: ------------------------------------------------------- + ### encode(object) Encodes `object` in msgpack, returns a [bl](http://npm.im/bl). ------------------------------------------------------- + ### decode(buf) Decodes buf from in msgpack. `buf` can be a `Buffer` or a [bl](http://npm.im/bl) instance. @@ -123,6 +127,7 @@ In order to support a stream interface, a user must pass in a [bl](http://npm.im ------------------------------------------------------- + ### registerEncoder(check(obj), encode(obj)) Register a new custom object type for being automatically encoded. @@ -136,6 +141,7 @@ The arguments are: ------------------------------------------------------- + ### registerDecoder(type, decode(buf)) Register a new custom object type for being automatically decoded. @@ -148,6 +154,7 @@ The arguments are: ------------------------------------------------------- + ### register(type, constructor, encode(obj), decode(buf)) Register a new custom object type for being automatically encoded and @@ -168,12 +175,14 @@ This is just a commodity that calls ------------------------------------------------------- + ### encoder() Builds a stream in object mode that encodes msgpack. ------------------------------------------------------- + ### decoder() Builds a stream in object mode that decodes msgpack.