Skip to content

Commit 4aa8120

Browse files
committedAug 4, 2016
doc: *.md formatting fixes in the top-level dir
Continuing what a58b48b did for the doc/ dir, this fixes some formatting issues in the *.md files that are placed directly in the top-level directory. README.md changes are excluded as they are covered by #7971 Refs: #7637 PR-URL: #7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 9ddc915 commit 4aa8120

File tree

2 files changed

+29
-25
lines changed

2 files changed

+29
-25
lines changed
 

‎BUILDING.md

+27-23
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ On FreeBSD and OpenBSD, you may also need:
2828
* libexecinfo (FreeBSD and OpenBSD only)
2929

3030

31-
```text
31+
```console
3232
$ ./configure
3333
$ make
3434
$ [sudo] make install
@@ -37,7 +37,7 @@ $ [sudo] make install
3737
If your Python binary is in a non-standard location or has a
3838
non-standard name, run the following instead:
3939

40-
```text
40+
```console
4141
$ export PYTHON=/path/to/python
4242
$ $PYTHON ./configure
4343
$ make
@@ -46,13 +46,13 @@ $ [sudo] make install
4646

4747
To run the tests:
4848

49-
```text
49+
```console
5050
$ make test
5151
```
5252

5353
To run the native module tests:
5454

55-
```text
55+
```console
5656
$ make test-addons
5757
```
5858

@@ -61,35 +61,35 @@ To run the npm test suite:
6161
*note: to run the suite on node v4 or earlier you must first*
6262
*run `make install`*
6363

64-
```
64+
```console
6565
$ make test-npm
6666
```
6767

6868
To build the documentation:
6969

7070
This will build Node.js first (if necessary) and then use it to build the docs:
7171

72-
```text
72+
```console
7373
$ make doc
7474
```
7575

7676
If you have an existing Node.js you can build just the docs with:
7777

78-
```text
78+
```console
7979
$ NODE=node make doc-only
8080
```
8181

8282
(Where `node` is the path to your executable.)
8383

8484
To read the documentation:
8585

86-
```text
86+
```console
8787
$ man doc/node.1
8888
```
8989

9090
To test if Node.js was built correctly:
9191

92-
```
92+
```console
9393
$ node -e "console.log('Hello from Node.js ' + process.version)"
9494
```
9595

@@ -107,19 +107,19 @@ Prerequisites:
107107
[Git for Windows](http://git-scm.com/download/win) includes Git Bash
108108
and tools which can be included in the global `PATH`.
109109

110-
```text
110+
```console
111111
> vcbuild nosign
112112
```
113113

114114
To run the tests:
115115

116-
```text
116+
```console
117117
> vcbuild test
118118
```
119119

120120
To test if Node.js was built correctly:
121121

122-
```text
122+
```console
123123
> Release\node -e "console.log('Hello from Node.js', process.version)"
124124
```
125125

@@ -136,7 +136,7 @@ Be sure you have downloaded and extracted [Android NDK]
136136
(https://developer.android.com/tools/sdk/ndk/index.html)
137137
before in a folder. Then run:
138138

139-
```
139+
```console
140140
$ ./android-configure /path/to/your/android-ndk
141141
$ make
142142
```
@@ -165,13 +165,13 @@ Node.js source does not include all locales.)
165165

166166
##### Unix / OS X:
167167

168-
```text
168+
```console
169169
$ ./configure --with-intl=full-icu --download=all
170170
```
171171

172172
##### Windows:
173173

174-
```text
174+
```console
175175
> vcbuild full-icu download-all
176176
```
177177

@@ -182,19 +182,19 @@ The `Intl` object will not be available, nor some other APIs such as
182182

183183
##### Unix / OS X:
184184

185-
```text
185+
```console
186186
$ ./configure --without-intl
187187
```
188188

189189
##### Windows:
190190

191-
```text
191+
```console
192192
> vcbuild without-intl
193193
```
194194

195195
#### Use existing installed ICU (Unix / OS X only):
196196

197-
```text
197+
```console
198198
$ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
199199
```
200200

@@ -210,14 +210,18 @@ Download the file named something like `icu4c-**##.#**-src.tgz` (or
210210

211211
##### Unix / OS X
212212

213-
```text
214-
# from an already-unpacked ICU:
213+
From an already-unpacked ICU:
214+
```console
215215
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu
216+
```
216217

217-
# from a local ICU tarball
218+
From a local ICU tarball:
219+
```console
218220
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz
221+
```
219222

220-
# from a tarball URL
223+
From a tarball URL:
224+
```console
221225
$ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz
222226
```
223227

@@ -227,7 +231,7 @@ First unpack latest ICU to `deps/icu`
227231
[icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`)
228232
as `deps/icu` (You'll have: `deps/icu/source/...`)
229233

230-
```text
234+
```console
231235
> vcbuild full-icu
232236
```
233237

‎CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ changed and why. Follow these guidelines when writing one:
100100

101101
A good commit log can look something like this:
102102

103-
```
103+
```txt
104104
subsystem: explaining the commit in one line
105105
106106
Body of commit message is a few lines of text, explaining things
@@ -122,7 +122,7 @@ what subsystem (or subsystems) your changes touch.
122122
If your patch fixes an open issue, you can add a reference to it at the end
123123
of the log. Use the `Fixes:` prefix and the full issue URL. For example:
124124

125-
```
125+
```txt
126126
Fixes: https://github.com/nodejs/node/issues/1337
127127
```
128128

0 commit comments

Comments
 (0)
Please sign in to comment.