Skip to content

Commit f0decc5

Browse files
author
bors-servo
authored
Auto merge of #270 - vitvakatu:fix-readme, r=jdm
Fix README Fixes #269 In addition, I changed links' format to make text more readable in raw Markdown. <!-- Reviewable:start --> --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/html5ever/270) <!-- Reviewable:end -->
2 parents cee43bd + 6da613d commit f0decc5

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
[API Documentation][API documentation]
66

7-
html5ever is an HTML parser developed as part of the [Servo](https://github.com/servo/servo) project.
7+
html5ever is an HTML parser developed as part of the [Servo][] project.
88

9-
It can parse and serialize HTML according to the [WHATWG](https://whatwg.org/) specs (aka "HTML5"). There are some omissions at present, most of which are documented [in the bug tracker](https://github.com/servo/html5ever/issues?q=is%3Aopen+is%3Aissue+label%3Aweb-compat). html5ever passes all tokenizer tests from [html5lib-tests](https://github.com/html5lib/html5lib-tests), and most tree builder tests outside of the unimplemented features. The goal is to pass all html5lib tests, and also provide all hooks needed by a production web browser, e.g. `document.write`.
9+
It can parse and serialize HTML according to the [WHATWG](https://whatwg.org/) specs (aka "HTML5"). There are some omissions at present, most of which are documented [in the bug tracker][]. html5ever passes all tokenizer tests from [html5lib-tests][], and most tree builder tests outside of the unimplemented features. The goal is to pass all html5lib tests, and also provide all hooks needed by a production web browser, e.g. `document.write`.
1010

1111
Note that the HTML syntax is a language almost, but not quite, entirely unlike XML. For correct parsing of XHTML, use an XML parser. (That said, many XHTML documents in the wild are serialized in an HTML-compatible form.)
1212

13-
html5ever is written in [Rust](http://www.rust-lang.org/), so it avoids the most notorious security problems from C, but has performance similar to a parser written in C. You can call html5ever as if it were a C library, without pulling in a garbage collector or other heavy runtime requirements.
13+
html5ever is written in [Rust][], so it avoids the most notorious security problems from C, but has performance similar to a parser written in C. You can call html5ever as if it were a C library, without pulling in a garbage collector or other heavy runtime requirements.
1414

1515

1616
## Getting started in Rust
@@ -22,7 +22,7 @@ Add html5ever as a dependency in your [`Cargo.toml`](http://crates.io/) file:
2222
html5ever = "*"
2323
```
2424

25-
Then take a look at [`examples/html2html.rs`](https://github.com/servo/html5ever/blob/master/examples/html2html.rs) and [`examples/print-rcdom.rs`](https://github.com/servo/html5ever/blob/master/examples/print-rcdom.rs) and the [API documentation][].
25+
Then take a look at [`examples/html2html.rs`] and [`examples/print-rcdom.rs`] and the [API documentation][].
2626

2727
## Getting started in other languages
2828

@@ -51,3 +51,9 @@ The code is cross-referenced with the WHATWG syntax spec, and eventually we will
5151
html5ever builds against the official stable releases of Rust, though some optimizations are only supported on nightly releases.
5252

5353
[API documentation]: http://doc.servo.org/html5ever/index.html
54+
[Servo]: https://github.com/servo/servo
55+
[Rust]: http://www.rust-lang.org/
56+
[in the bug tracker]: https://github.com/servo/html5ever/issues?q=is%3Aopen+is%3Aissue+label%3Aweb-compat
57+
[html5lib-tests]: https://github.com/html5lib/html5lib-tests
58+
[`examples/html2html.rs`]: https://github.com/servo/html5ever/blob/master/html5ever/examples/html2html.rs
59+
[`examples/print-rcdom.rs`]: https://github.com/servo/html5ever/blob/master/html5ever/examples/print-rcdom.rs

0 commit comments

Comments
 (0)