Carol (Nichols || Goulding)
ac1749ff2f
Implement a rustdoc_include preprocessor ( #1003 )
...
* Allow underscores in the link type name
* Add some tests for include anchors
* Include parts of Rust files and hide the rest
Fixes #618 .
* Increase min supported Rust version to 1.35
* Add a test for a behavior of rustdoc_include I want to depend on
At first I thought this was a bug, but then I looked at some use cases
we have in TRPL and decided this was a feature that I'd like to use.
2019-10-06 00:27:03 +02:00
Carol (Nichols || Goulding)
a873d46871
Implement a markdown renderer ( #1018 )
...
Use case: when trying to `mdbook test` a file that has many `include`
directives, and a test fails, the line numbers in the `rustdoc` output
don't match the line numbers in the original markdown file.
Turning on the markdown renderer implemented here lets you see what is
being passed to `rustdoc` by saving the markdown after the preprocessors
have run.
This renderer could be helpful for debugging many preprocessors, but
it's probably not useful in the general case, so it's turned off by
default.
2019-08-30 12:20:53 +02:00
Carol (Nichols || Goulding)
31e36f85e7
Update specified minimum Rust version and test it in travis
2019-06-20 15:04:55 -04:00
j143-bot
d07bd9fed4
Update the master-docs link to ../mdBook ( #958 )
2019-06-20 08:54:38 +02:00
lzutao
8542f7f29d
Transition to 2018 edition ( #933 )
...
* Transition to 2018 edition
* Update Travis CI badge in README
* Remove non-idiomatic `extern crate` lines
2019-05-25 20:50:41 +02:00
Felix Rabe
01fd7a76f0
Typo
2019-04-23 22:11:12 +02:00
Michael Bryan
cffc385b0c
Updated the user guide's config section to mention specifying plugin commands
2018-10-20 14:16:07 +08:00
Michael Bryan
e73928f933
Mentioned plugins in the README
2018-10-20 14:01:51 +08:00
Philipp Hansch
90bd7207ec
Add minimum required Rust version to README
2018-05-18 09:04:41 +02:00
Michael Bryan
d48a27f94f
Updated the appveyor CI image
2018-03-15 09:19:58 +08:00
Bulat Musin
6af77a7792
Update documentation to reflect addition of clean subcommand. ( #607 )
...
* update documentation
Update README.md and User Guide to reflect addition of `clean`
subcommand. Do minor spelling fixes too.
* fix grammar in `clean` documentation
2018-02-18 15:04:04 +08:00
Ofek Lev
31a370d149
fix readme ( #606 )
2018-02-05 07:11:55 +08:00
Markus Kohlhase
b1b8ba4b98
fix(doc): make installation from git work again ( #570 )
...
cargo install --git https://github.com/rust-lang-nursery/mdBook.git
leads to error: multiple packages with binaries found: mdbook, mdbook-wordcount
Fix: append name of binary (`mdbook`).
2018-01-23 21:07:14 +08:00
Michael Bryan
b9ab71b231
Reformatted the README and added a link to the master docs ( #525 )
2018-01-05 11:32:54 +08:00
Anna Liao
5ce05a79be
updated links from azerupi to rust-lang-nursery ( #489 )
2017-11-22 11:35:18 +01:00
Aaron Turon
c51e080783
Update broken doc link
2017-11-21 20:32:08 -08:00
Mathieu David
0226da91e4
Fix shield in README
2017-09-11 19:47:39 +02:00
Mathieu David
3b0d2d1238
Add a note about version pinning for people doing automatic deployments of their books
2017-08-01 14:16:39 +02:00
Mathieu David
9447274fa5
Modify the Readme for the new contribution guide
2017-05-16 22:10:24 +02:00
Tshepang Lekhonkhobe
4af107b0ca
typos
2017-03-29 16:42:55 +02:00
Jesse Stricker
b75243f1f5
Fix some minor typos
2016-12-29 16:25:51 +01:00
Mathieu David
a7ae0b99c4
Update README.md
2016-08-13 11:36:28 +02:00
Boris-Chengbiao Zhou
2f43167b75
Add documentation for Serve feature
2016-04-02 05:43:21 +02:00
Mathieu David
d0e39f469a
Update installation instructions in the README
...
Closes #123
2016-03-22 14:06:32 +01:00
Mathieu David
9e34eccb3e
Add windows (AppVeyor) build badge
2016-03-08 01:03:44 +01:00
Eric Bailey
276cd8d490
Update README.md
...
Replace two contractions with possessive pronouns: it's => its.
2016-01-28 00:55:25 -06:00
Mathieu David
e958fc8605
update readme
2016-01-13 22:40:30 +01:00
Mathieu David
d376b0663a
Bumped version to 0.0.4 (after publishing 0.0.3 to crates.io) + updated README to use cargo install for the installation
2015-12-11 22:17:05 +01:00
Mathieu David
259ecfb178
Update readme
2015-09-24 21:07:05 +02:00
Mathieu David
bd99a4382f
Converted all css to stylus
2015-09-18 22:13:55 +02:00
Mathieu David
e377f4702f
Preliminary setup for switching from pure css to stylus
2015-09-18 14:46:55 +02:00
Mathieu David
9e2a62f371
travis build icon is now a link to travis in README
2015-08-31 17:16:26 +02:00
Mathieu David
ed0c292e82
Changed Travis build status to master branch only
2015-08-16 20:12:48 +02:00
waynenilsen
541f990ae5
added installation information
...
You may want to move around where it goes I guess. I'm just thinking it might be nice to have at least this much information in there.
2015-08-12 09:04:00 -04:00
Mathieu David
909953d877
Added badges to crates.io and license
2015-08-08 01:14:23 +02:00
Mathieu David
812f8d35e8
Update README.md
2015-08-07 12:14:13 +02:00
Mathieu David
bbb3c6e789
Update README.md
2015-08-06 00:05:52 +02:00
Mathieu David
9d29fdaf42
Added Travis build status icon [ci skip]
2015-08-01 10:44:58 +02:00
Mathieu David
979c617b7e
Added link to example
2015-07-30 12:58:54 +02:00
Mathieu David
44b467162a
Update README.md
2015-07-29 18:52:46 +02:00
Mathieu David
925b0834cb
link to enhancement label in issue tracker
2015-07-29 15:07:34 +02:00
Mathieu David
b7ef472452
Update README.md
2015-07-29 15:06:22 +02:00
Mathieu David
0c3266e40f
Update README.md
2015-07-29 14:50:17 +02:00
Mathieu David
6973994518
Update README.md
2015-07-29 14:34:15 +02:00
Mathieu David
ffb22c5a3b
Update README.md
2015-07-29 14:02:05 +02:00
Mathieu David
0b0b9b0bb1
update progress
2015-07-29 00:59:02 +02:00
Mathieu David
91c29ef81e
Update README.md
2015-07-19 15:52:27 +02:00
Mathieu David
02b5b9c194
Update README.md
2015-07-08 00:11:02 +02:00
Mathieu David
fc256f884b
Update README.md
2015-07-08 00:07:36 +02:00
Mathieu David
39c0344f9a
Added README.md
2015-07-08 00:04:28 +02:00
