Skip to content

Commit 5b7083b

Browse files
mkrufkykkoopa
authored andcommitted
README.md: newline is required before ## headings to render properly (nodejs#653)
newline is required before `##` headings to render properly on markdown renderers used on websites other than github, such as npmjs. Signed-off-by: Michael Ira Krufky <[email protected]> closes nodejs#652
1 parent ace8934 commit 5b7083b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ This project also contains some helper utilities that make addon development a b
2424
* **[Governance & Contributing](#governance)**
2525

2626
<a name="news"></a>
27+
2728
## News & Updates
2829

2930
<a name="usage"></a>
31+
3032
## Usage
3133

3234
Simply add **NAN** as a dependency in the *package.json* of your Node addon:
@@ -46,6 +48,7 @@ Pull in the path to **NAN** in your *binding.gyp* so that you can use `#include
4648
This works like a `-I<path-to-NAN>` when compiling your addon.
4749

4850
<a name="example"></a>
51+
4952
## Example
5053

5154
Just getting started with Nan? Take a look at the **[Node Add-on Examples](https://github.com/nodejs/node-addon-examples)**.
@@ -59,6 +62,7 @@ Yet another example is **[nan-example-eol](https://github.com/CodeCharmLtd/nan-e
5962
Also take a look at our comprehensive **[C++ test suite](https://github.com/nodejs/nan/tree/master/test/cpp)** which has a plethora of code snippets for your pasting pleasure.
6063

6164
<a name="api"></a>
65+
6266
## API
6367

6468
Additional to the NAN documentation below, please consult:
@@ -308,6 +312,7 @@ The hooks to access V8 internals—including GC and statistics—are different a
308312

309313

310314
<a name="tests"></a>
315+
311316
### Tests
312317

313318
To run the NAN tests do:
@@ -326,6 +331,7 @@ make test
326331
```
327332

328333
<a name="governance"></a>
334+
329335
## Governance & Contributing
330336

331337
NAN is governed by the [io.js](https://iojs.org/) Addon API Working Group
@@ -361,6 +367,7 @@ Modifications of the contents of the NAN repository are made on a collaborative
361367
If a change proposal cannot reach a consensus, a WG member can call for a vote amongst the members of the WG. Simple majority wins.
362368

363369
<a id="developers-certificate-of-origin"></a>
370+
364371
## Developer's Certificate of Origin 1.1
365372

366373
By making a contribution to this project, I certify that:
@@ -388,6 +395,7 @@ By making a contribution to this project, I certify that:
388395
this project or the open source license(s) involved.
389396

390397
<a name="collaborators"></a>
398+
391399
### WG Members / Collaborators
392400

393401
<table><tbody>

0 commit comments

Comments
 (0)