f0ac13e3e2
Document preferred-dark-theme config option
2019-09-26 12:09:30 -04:00
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
aaeb3e2852
Merge pull request #985 from Michael-F-Bryan/enable-caching
...
Allow backends to cache previous results
2019-08-07 10:26:06 -07:00
e48fed74bf
Add `--path .` to cargo install commands.
...
Changing `cargo install` to `cargo install --path .` prevents the following error:
<span style="color: red;">error:</span> Using `cargo install` to install the binaries for the package in current working directory is no longer supported, use `cargo install --path .` instead. Use `cargo build` if you want to simply build the package.
2019-07-31 14:49:25 -07:00
5b0a23ebab
Updated the documentation
2019-07-21 02:40:58 +08:00
9ec43b6c6d
Remove redundant occurrence of 'in the'
2019-07-17 17:20:18 +02:00
e5ace6d6a4
Fix some broken links.
2019-07-15 12:51:46 -07:00
d8a68ba3f6
Document anchor-based partial include feature in the book
2019-07-14 21:55:51 -04:00
bb3398bdbb
Merge pull request #941 from rnitta/configurable-language
...
Change language attribute of the book to configurable
2019-06-24 08:56:22 -07:00
1cd1151790
Release 0.3.0
2019-06-18 15:24:26 -07:00
84d4063e4a
Fix-681 ( #954 )
...
* Adding section for code snippets.
* Reformatting sections.
* Update mdbook.md
2019-06-13 07:38:12 +02:00
3cfed10098
Update to pulldown-cmark 0.5. ( #898 )
...
* Update to pulldown-cmark 0.4.1.
* Update to pulldown-cmark 0.5.2.
* Remove pulldown-cmark-to-cmark dependency.
Since it is not compatible with the new pulldown-cmark. This example isn't
directly usable, anyways, and I think the no-op example sufficiently shows how
to make a preprocessor.
* cargo fmt
* Fix example link.
2019-06-11 18:26:24 +02:00
4f7c299de7
update language attribute to configurable
2019-05-30 11:53:49 +09:00
e3ec751a3f
Issue 703 ( #929 )
...
* Replace all occurances of altenate backend with alternative backed
Rename test for consistency of the terminology.
* Use better sed command
2019-05-19 22:16:10 +02:00
fc565df86b
Some documentation fixes. ( #925 )
2019-05-19 00:05:57 +02:00
2752c88c46
Fix issue #703 . ( #928 )
2019-05-18 23:38:08 +02:00
c3284a2ae9
Update mdbook 0.1 -> 0.2 in docs for CI ( #918 )
2019-05-11 20:30:21 +02:00
7f3a0ff6a0
Merge pull request #886 from bluejekyll/master
...
add docs for publishing to github pages manually
2019-04-30 00:50:58 +02:00
aea317e173
Update continuous-integration.md
2019-04-30 00:50:35 +02:00
f9454615b1
Update book-example/src/continuous-integration.md
...
Co-Authored-By: bluejekyll <benjaminfry@me.com>
2019-04-29 15:33:31 -07:00
39211291d9
Update book-example/src/continuous-integration.md
...
Co-Authored-By: bluejekyll <benjaminfry@me.com>
2019-04-29 15:33:25 -07:00
11f86f4511
Correct grammar: remove the redundancy
2019-04-12 22:53:21 +08:00
62af2367bb
add docs for publishing to github pages manually
2019-03-12 11:22:00 -07:00
b675b91980
Update broken link
...
https://www.rust-lang.org/downloads.html is the outdated link.
2018-12-15 10:09:23 +09:00
42b87e0fbc
Merge pull request #804 from Bassetts/default-theme-option
...
Default theme option
2018-10-30 21:18:48 +08:00
33add4b532
Merge pull request #782 from mattico/document-dest-dir-rel
...
Document dest-dir relative path behavior
2018-10-23 12:16:37 -05:00
b4538da9c3
Merge pull request #802 from Bassetts/git-button
...
Implement a git repository button
2018-10-23 19:16:45 +08:00
eccec9bb52
Update documentation for
2018-10-21 13:16:59 +01:00
cffc385b0c
Updated the user guide's config section to mention specifying plugin commands
2018-10-20 14:16:07 +08:00
10b69e60c8
Add documentation and tests
2018-10-15 21:40:59 +01:00
5bfdf9fcc8
Added git-repository-icon option
...
Updated documentation and added tests.
2018-10-15 19:48:54 +01:00
29f8b791f1
Merge pull request #792 from rust-lang-nursery/custom-preprocessor
...
WIP: Custom Preprocessors
2018-10-16 00:02:12 +08:00
877bf37d18
avoid using `cd` in example travis-ci script ( #803 )
2018-10-15 18:52:37 +08:00
b1c7c54108
Rewrote a large proportion of the Preprocessor docs to be up-to-date
2018-09-25 19:48:20 +08:00
e4eddb3f26
Fix broken link to API pages ( #795 )
2018-09-19 23:32:37 +08:00
ced74ca4dd
Updated the documentation for new preprocessor format ( #787 )
...
* Updated the documentation for new preprocessor format
* adjusted the descriptions for preprocessors
2018-09-10 19:51:18 +08:00
a9f3be6f44
Make serve command note more prominent
2018-09-06 10:24:56 -05:00
34356b87a0
Document dest-dir relative path behavior
2018-09-06 10:24:42 -05:00
d9c1c77aae
Fix a typo
2018-08-20 23:48:18 -04:00
322e8fcf77
Rewrap guide markdown at 80 columns
...
Much of the book was wrapped at around 80 columns, but let's make this consistent.
2018-08-02 21:34:26 -05:00
a8a460545f
Update installation instructions in guide
2018-08-02 21:19:47 -05:00
f30ce0184d
Fix escaped link preprocessor
2018-08-02 19:04:35 -05:00
a776aa9783
Update documentation for commands
2018-08-02 17:01:47 -05:00
8cd7061ff2
Add search.enable config field
2018-07-23 12:08:04 -05:00
21c24c2815
- Fix token type
...
OAuth token type doesn't work. Have to change it to PAT.
2018-07-21 19:23:47 +05:30
bdb37ec117
Use relative links and translate internal references ( #603 )
...
* Relative links for 0.1.8
* Compat for IE11 search
2018-07-11 21:33:44 +08:00
488ace15ff
user guide: Add instructions for running `mdbook` in CI
...
This adds instructions for building and testing books in CI on every PR and
push, as well as instructions for how to automatically deploy to gh-pages on
successful CI runs on `master`.
Fixes #714
2018-06-22 10:31:49 -07:00
41d372de26
Update documentation for preprocessor ( #686 )
2018-05-06 23:48:11 +08:00
69599646e7
Add index preprocessor ( #685 )
...
* Add index preprocessor
README.md is a de facto index file in markdown-based documentation.
Hence, we respect to README.md and convert it into index.html.
* Fix warning for unused variables
* Update tests for config
* Match file stem case-insensitively for IndexPreprocessor
* Add tests for IndexPreprocessor
* Update book example to fit index preprocessor
2018-05-04 19:41:28 +08:00
38279deed7
Add a note in MathJax documentation
2018-04-03 10:17:06 +02:00
Flying-Toast
Carol (Nichols || Goulding)
Eric Huss
Liam Beckman
Michael Bryan
Matthias Eichstedt
Benoît CORTIER
Eric Zubriski
rnitta
Bas Bossink
Roman Proskuryakov
Dylan DPC
ji.zhou
Benjamin Fry
Shawn
Matt Ickstadt
Jason Liquorish
xyh
mwilbur
Ramon Buckland
Danny Guo
Ganesh Prasad Kumble
cetra3
Nick Fitzgerald
Weihang Lo
Davide Aversa