Commit Graph

55 Commits

Author SHA1 Message Date
Michael Bryan c777913136
Updated the configuration chapter in the book-example 2017-11-12 21:37:38 +08:00
Michael Bryan 8fbc59720d Added myself to the contributors list 2017-10-04 20:04:26 +08:00
Daan van Berkel bd30cae17e
Correct inline mathematics delimiters
This fixes #424
2017-09-08 09:21:20 +02:00
Mathieu David a1926bbe8e Update documentation for mathjax 2017-08-11 13:55:11 +02:00
Mathieu David 094c1e7a52 Add documentation about additional-js 2017-08-11 13:55:11 +02:00
Mathieu David 4528e24080 Improve wording of documentation 2017-08-11 13:55:11 +02:00
Mathieu David 4f754a73ba Remove the empty introduction chapter 2017-08-02 15:04:03 +02:00
Mathieu David 28afebdca2 Merge branch 'minor_refactor' of https://github.com/budziq/mdBook into budziq-minor_refactor 2017-06-23 01:09:26 +02:00
Jimmy Do 193f014a5b Add an option to convert to curly quotes when rendering to HTML 2017-06-18 10:11:04 -07:00
Michal Budzynski e8908e32c9 Minor cleanup
- removing need to explicitly use `Path::new` all over the place
- removed warnings from doctests (normally invisible unless `cargo test -- --nocapture`)
- no doctests are norun/ignore now
- updated docs both in book-example and in docs not to refer to nonexisting API's
2017-06-14 21:55:42 +02:00
Mathieu David 23efa9e146 Document the TOML configuration file 2017-06-04 20:41:31 +02:00
Michal Budzynski be3418a269 Now changes to `theme` directory trigger rebuild for `mdbook serve`
As `theme` dir is no longer under `src`. Updates to "theme" did not
trigger book rebuild.
Also fixed misleading docs about `theme` dir being located in `src`
2017-06-01 13:11:39 +02:00
Mathieu David 0443f8a709 Merge pull request #262 from Rufflewind/master
Fix broken link in book-example/src/lib/lib.md
2017-05-17 11:37:07 +02:00
Michael-F-Bryan 95750be815 Added a note about google analytics to the docs 2017-05-16 17:40:14 +08:00
Phil Ruffwind 7eade3b101 Fix broken link in book-example/src/lib/lib.md
The template sets `<base href="../">` so it's not necessary to have
`../` in the link.
2017-05-01 20:32:06 -04:00
Pete Hayes 32814f6f71 Remove blank ***note*** section 2017-01-17 00:19:09 +00:00
Pete Hayes ac6f15cb27 Add docs for --dest-dir option 2017-01-17 00:19:09 +00:00
Matt Brubeck 21bc3d47c8 Add a CLI option to open a web browser 2017-01-01 09:58:20 -08:00
Mathieu David a6e1844aad Merge pull request #193 from mbrubeck/chapter-title
Add current chapter title to handlebars context
2016-12-31 23:43:39 +01:00
Matt Brubeck 3a0cfc87df Add current chapter title to handlebars context 2016-12-31 10:34:36 -08:00
Matt Brubeck b1e384b03b Fix a broken link in the documentation
This fixes a broken link on http://azerupi.github.io/mdBook/cli/init.html

The `..` is redundant because the document's base URI is set to
`path_to_root`.  It breaks if the base URI is not at the server root.
2016-12-31 09:20:54 -08:00
Gambhiro 552e39c897 update example to encourage using book.toml 2016-12-23 08:17:04 +00:00
Gambhiro 85d8e2ebd3 use theme_path key in book.json when given 2016-12-07 14:22:32 +00:00
Bruce Mitchener 2dfc25fc6e Fix typo. 2016-08-27 00:28:17 +07:00
Carol (Nichols || Goulding) a0d8013242 Tell rustdoc this mathjax is not rust
Use bash for the grey background though.
2016-08-06 15:25:40 -04:00
Carol (Nichols || Goulding) 1b9d55bcd5 Put spaces between `#` and hidden lines 2016-08-06 15:25:40 -04:00
Ferris 317023cd0e Added option to configure serve interface and address browser will use to connect to websocket server. 2016-08-05 21:40:00 +00:00
Jesse Stricker 3c10a85735 Add documentation and example for description config 2016-02-25 15:01:16 +01:00
Mathieu David 01c5085725 Add an entry about the favicon in the docs 2016-02-22 18:01:36 +01:00
Mathieu David bb0c878e06 #29 update doc with an example of runnable rust code 2016-01-01 01:57:21 +01:00
Mathieu David dc8f6cd5e9 Add contributors to the doc + set visisted links to the same color as normal links 2015-12-30 15:59:18 +01:00
Mathieu David 4f583dfea9 Update documentation, Closes #80 2015-12-30 15:04:24 +01:00
Steve Klabnik eed440ef5a fix mdbook test for the book 2015-12-29 17:59:08 -05:00
Steve Klabnik e8436d2fd2 Add some documentation for mdbook test 2015-12-29 17:58:56 -05:00
Mathieu David cdbb2ee5fd Watch builds are now spawned in new threads (using crossbeam) and there is a timelock, preventing multiple builds being triggered in less than a second 2015-11-09 14:31:00 +01:00
Mathieu David 522eef9296 first implementation of the watch sub-command. #61 Needs refining, bug in notify made me use recursion, afraid of hitting the max recursion limit... 2015-09-27 14:38:37 +02:00
Mathieu David c5fa1854c3 update docs 2015-09-24 22:19:14 +02:00
Mathieu David 2b905aa5aa Fix missing spaces in example book 2015-09-24 13:47:14 +02:00
Mathieu David 95dfff008c Local fallback for jquery #46 2015-09-13 19:16:11 +02:00
Mathieu David a050d9c4ad Big refactoring, now using enum for different book items (Chapter, Affix, Spacer, ...) Closes #9 2015-09-11 20:52:55 +02:00
Mathieu David 0932bfd576 Big clean-up, reduced the unwrap's to 2 in the library part! Closes #36 The unwraps where replaced with more diverse error messages #14 2015-08-11 22:55:51 +02:00
Mathieu David b6034e8fbe Modified the doc for --theme flag. Closes #37 2015-08-11 17:16:03 +02:00
Mathieu David b7214f92a1 Add documentation for MDBook #30 2015-08-06 21:10:59 +02:00
Mathieu David c6b6069ed3 Tweaks to the docs + clean-up 2015-08-06 15:24:34 +02:00
Mathieu David 15a5378b2b Cosmetic fix to docs 2015-08-06 15:09:37 +02:00
Mathieu David a0040733e9 Fixed rust example in doc + some tweaks for html validation 2015-08-06 14:09:55 +02:00
Mathieu David fd57d03992 Fix colors in deploy script + Fix link to API docs 2015-08-06 13:30:08 +02:00
Mathieu David e725215103 Add rustdoc generated API doc 2015-08-06 12:38:48 +02:00
Mathieu David 991ccb5495 Added some chapters for the documentation #30 + tweaked the syntax highlighting theme 2015-08-05 20:36:21 +02:00
Mathieu David 58d18d467c Fixed a bug where custom theme was appended to default theme + Changed syntax highlighting theme to something lighter, the dark theme did not fit the light style of the page 2015-08-05 19:14:03 +02:00