Skip to content

Commit 3acdf70

Browse files
committed
Merge pull request #189 from samelawrence/master
Update README.md
2 parents f050b08 + 0d0e129 commit 3acdf70

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44

55
# markdown-js
66

7-
Yet another markdown parser, this time for JavaScript. There's a few
8-
options that precede this project but they all treat markdown to HTML
9-
conversion as a single step process. You pass markdown in and get HTML
7+
Yet another Markdown parser, this time for JavaScript. There's a few
8+
options that precede this project but they all treat Markdown to HTML
9+
conversion as a single step process. You pass Markdown in and get HTML
1010
out, end of story. We had some pretty particular views on how the
1111
process should actually look, which include:
1212

13-
* producing well-formed HTML. This means that `em` and `strong` nesting
13+
* Producing well-formed HTML. This means that `em` and `strong` nesting
1414
is important, as is the ability to output as both HTML and XHTML
15-
* having an intermediate representation to allow processing of parsed
15+
* Having an intermediate representation to allow processing of parsed
1616
data (we in fact have two, both [JsonML]: a markdown tree and an HTML tree)
17-
* being easily extensible to add new dialects without having to
17+
* Being easily extensible to add new dialects without having to
1818
rewrite the entire parsing mechanics
19-
* having a good test suite. The only test suites we could find tested
19+
* Having a good test suite. The only test suites we could find tested
2020
massive blocks of input, and passing depended on outputting the HTML
2121
with exactly the same whitespace as the original implementation
2222

@@ -43,7 +43,7 @@ download the version you want (minified or not).
4343

4444
### Node
4545

46-
The simple way to use it with node is:
46+
The simple way to use it with Node is:
4747

4848
```js
4949
var markdown = require( "markdown" ).markdown;
@@ -77,10 +77,10 @@ It also works in a browser; here is a complete example:
7777
</html>
7878
```
7979

80-
### Command line
80+
### Command Line
8181

8282
Assuming you've installed the `md2html` script (see Installation,
83-
above), you can convert markdown to html:
83+
above), you can convert Markdown to HTML:
8484

8585
```bash
8686
# read from a file
@@ -90,7 +90,7 @@ md2html /path/to/doc.md > /path/to/doc.html
9090
echo 'Hello *World*!' | md2html
9191
```
9292

93-
### More options
93+
### More Options
9494

9595
If you want more control check out the documentation in
9696
[the .js files under src/][src_folder] which details all the methods and parameters
@@ -139,13 +139,13 @@ console.log( html );
139139

140140
## Intermediate Representation
141141

142-
Internally the process to convert a chunk of markdown into a chunk of
142+
Internally the process to convert a chunk of Markdown into a chunk of
143143
HTML has three steps:
144144

145-
1. Parse the markdown into a JsonML tree. Any references found in the
145+
1. Parse the Markdown into a JsonML tree. Any references found in the
146146
parsing are stored in the attribute hash of the root node under the
147147
key `references`.
148-
2. Convert the markdown tree into an HTML tree. Rename any nodes that
148+
2. Convert the Markdown tree into an HTML tree. Rename any nodes that
149149
need it (`bulletlist` to `ul` for example) and lookup any references
150150
used by links or images. Remove the references attribute once done.
151151
3. Stringify the HTML tree being careful not to wreck whitespace where
@@ -183,16 +183,16 @@ syntax if you don't want to include Maruku support.
183183
[Gruber]: http://daringfireball.net/projects/markdown/syntax
184184
[Maruku]: http://maruku.rubyforge.org/maruku.html
185185

186-
## Running tests
186+
## Running Tests
187187

188-
To run the tests under node you will need tap installed (it's listed as a
188+
To run the tests under Node you will need tap installed (it's listed as a
189189
`devDependencies` so `npm install` from the checkout should be enough), then do
190190

191191
$ npm test
192192

193193
## Contributing
194194

195-
Do the usual github fork and pull request dance. Add yourself to the
195+
Do the usual GitHub fork and pull request dance. Add yourself to the
196196
contributors section of [package.json] too if you want to.
197197

198198
[package.json]: https://github.com/evilstreak/markdown-js/blob/master/package.json

0 commit comments

Comments
 (0)