Michael Bryan
6119972fa7
Merge pull request #581 from bmusin/patch-3
...
fix typo
2018-01-25 17:49:40 +08:00
Bulat Musin
53b902b479
remove dot for consistency ( #580 )
2018-01-25 07:32:52 +08:00
Bulat Musin
2e9d8671a0
fix typo (insert dash) ( #582 )
2018-01-25 07:32:33 +08:00
Bulat Musin
50cdfc9623
fix typo ( #579 )
2018-01-25 07:25:56 +08:00
Bulat Musin
d47f4dce7f
fix typo
2018-01-24 21:52:51 +03:00
Michael Bryan
492f393c0b
Escaped the book's example {{#include ...}} tag
2018-01-23 21:13:33 +08:00
Michael Bryan
9fe19d8f31
Increase Documentation Coverage ( #543 )
...
* Added documentation to the `config` module
* Added an example to the `config` module
* Updated the docs in lib.rs regarding implementing backends
* Started writing an alternate backends walkthrough
* Mentioned the output.foo.command key
* Added example output
* Added a config section to the backends tutorial
* Finished off the backends tutorial
* Made sure travis checks mdbook-wordcount
* Fixed the broken link at in the user guide
* Changed how travis builds the project
* Added a conclusion
* Went through and documented a lot of stuff
* Added a preprocessors chapter and updated For Developers
2018-01-21 22:35:11 +08:00
projektir
57f960a03b
Documenting the editor #521
2018-01-16 21:26:13 -08:00
Michael Bryan
a1b6ccc29a
Override configuration using environment variables ( #541 )
...
* Added the ability to update config settings from env vars
* Added tests
* Documented that you can override configuration with environment
variables
* Refactored the config get() methods to use toml-query
* Made the `Updateable` trait more generic
2018-01-14 02:38:43 +08:00
vabc3
e825357848
Add option to disable section label in html ( #533 )
2018-01-08 00:31:46 +08:00
Michael Bryan
fd7e8d1b7b
Add support for alternative backends ( #507 )
...
* Added a mechanism for creating alternate backends
* Added a CmdRenderer and the ability to have multiple renderers
* Made MDBook::load() autodetect renderers
* Added a couple methods to RenderContext
* Converted RenderContext.version to a String
* Made sure all alternate renderers are invoked as `mdbook-*`
* Factored out the logic for determining which renderer to use
* Added tests for renderer detection
* Made it so `mdbook test` works on the book-example again
* Updated the "For Developers" docs
* Removed `[output.epub]` from the example book's book.toml
* Added a bit more info on how backends should work
* Added a `destination` key to the RenderContext
* Altered how we wait for an alternate backend to finish
* Refactored the Renderer trait to not use MDBook and moved livereload to the template
* Moved info for developers out of the book.toml format chapter
* MOAR docs
* MDBook::build() no longer takes &mut self
* Replaced a bunch of println!()'s with proper log macros
* Cleaned up the build() method and backend discovery
* Added a couple notes and doc-comments
* Found a race condition when backends exit really quickly
* Added support for backends with arguments
* Fixed a funny doc-comment
2018-01-07 22:10:48 +08:00
Michael Bryan
21498631b3
Made sure the dummy book can build
2017-12-10 22:50:57 +11:00
Chris Spiegel
dacc274e0d
Add myself to the contributors list.
2017-11-30 07:54:43 -08:00
Chris Spiegel
b0b09bad3f
Clean up build configuration.
...
This rolls all "create missing" handling into BuildConfig, and moves the
build-dir option from the "book" table to the "build" table. Some
documentation cleanup surrounding the build table is also updated.
2017-11-30 07:39:58 -08:00
Chris Spiegel
93874edebf
Add a create-missing option to book.toml.
2017-11-29 20:02:58 -08:00
Anna Liao
5ce05a79be
updated links from azerupi to rust-lang-nursery ( #489 )
2017-11-22 11:35:18 +01:00
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
f222134ee6
book-example/book is not tracked anymore and the deploy script should build the output before pushing it to gh-pages
2015-08-05 20:47:21 +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
Mathieu David
90719f721b
Added syntax highlighting with highlight.js Closes #31 + Added a new chapter to the docs #30 .
2015-08-05 18:28:59 +02:00
Mathieu David
16318273f3
Merge the updated handlebars helpers in master. Closes #26
2015-08-04 12:58:20 +02:00
Mathieu David
842196b91c
Cleaned up the handlebars helpers, it's a lot more customizable because the user can put whatever template he wants inside and I just expose link and name of previous / next chapter. JavaScript part is removed. #26
2015-08-04 12:52:32 +02:00
Mathieu David
4ae77d771a
Moved book.json from src to root. Now src can be set to whatever you want. Closes #27
2015-08-04 01:25:41 +02:00
Mathieu David
a77fe94c02
Started to clean the 'previous' and 'next' handlebars helpers #26 But got stuck, waiting for a response
2015-08-03 22:09:26 +02:00
Mathieu David
91b0a99d81
Fix bug in menu-bar title, again... Because I didn't solve it previously
2015-08-03 18:17:39 +02:00
Mathieu David
fd58a4d441
Fix bug where menu-bar title was on top of the menu-bar icons making them unclickable
2015-08-03 14:59:18 +02:00
Mathieu David
c64824a18c
Added author and dest field in book.json, fixed bug when output directory did not exist. Closes #7
2015-08-03 14:23:32 +02:00
Mathieu David
9b4298c066
Initial implementation for reading the config file: book.json #7
2015-08-03 01:37:13 +02:00
Mathieu David
ef00851b8e
Fixes #24
2015-08-01 17:21:05 +02:00
Mathieu David
5b11907a56
Added navigation icons + javascript code to hide them when there is no previous or next. Closes #12
2015-08-01 14:18:25 +02:00
Mathieu David
31f638eae3
Add active class to currently viewed chapter in the sidebar. Closes #20
2015-07-31 15:06:08 +02:00
Mathieu David
18c3ed4540
Added an example book also containing the docs
2015-07-30 11:59:08 +02:00
