actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,204 Commits 9 Branches 89 Tags 16 MiB
Commit Graph

114 Commits

Author SHA1 Message Date
Bas Bossink 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
Eric Huss fc565df86b Some documentation fixes. (#925) 2019-05-19 00:05:57 +02:00
Bas Bossink 2752c88c46 Fix issue #703. (#928) 2019-05-18 23:38:08 +02:00
Roman Proskuryakov c3284a2ae9 Update mdbook 0.1 -> 0.2 in docs for CI (#918) 2019-05-11 20:30:21 +02:00
Dylan DPC 7f3a0ff6a0
Merge pull request #886 from bluejekyll/master 
add docs for publishing to github pages manually
 2019-04-30 00:50:58 +02:00
Dylan DPC aea317e173
Update continuous-integration.md 2019-04-30 00:50:35 +02:00
Dylan DPC f9454615b1
Update book-example/src/continuous-integration.md 
Co-Authored-By: bluejekyll <benjaminfry@me.com>
 2019-04-29 15:33:31 -07:00
Dylan DPC 39211291d9
Update book-example/src/continuous-integration.md 
Co-Authored-By: bluejekyll <benjaminfry@me.com>
 2019-04-29 15:33:25 -07:00
ji.zhou 11f86f4511 Correct grammar: remove the redundancy 2019-04-12 22:53:21 +08:00
Benjamin Fry 62af2367bb add docs for publishing to github pages manually 2019-03-12 11:22:00 -07:00
Shawn b675b91980
Update broken link 
https://www.rust-lang.org/downloads.html is the outdated link.
 2018-12-15 10:09:23 +09:00
Michael Bryan 42b87e0fbc
Merge pull request #804 from Bassetts/default-theme-option 
Default theme option
 2018-10-30 21:18:48 +08:00
Matt Ickstadt 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
Michael Bryan b4538da9c3
Merge pull request #802 from Bassetts/git-button 
Implement a git repository button
 2018-10-23 19:16:45 +08:00
Jason Liquorish eccec9bb52 Update documentation for 2018-10-21 13:16:59 +01:00
Michael Bryan cffc385b0c
Updated the user guide's config section to mention specifying plugin commands 2018-10-20 14:16:07 +08:00
Jason Liquorish 10b69e60c8 Add documentation and tests 2018-10-15 21:40:59 +01:00
Jason Liquorish 5bfdf9fcc8 Added git-repository-icon option 
Updated documentation and added tests.
 2018-10-15 19:48:54 +01:00
Michael Bryan 29f8b791f1
Merge pull request #792 from rust-lang-nursery/custom-preprocessor 
WIP: Custom Preprocessors
 2018-10-16 00:02:12 +08:00
xyh 877bf37d18 avoid using `cd` in example travis-ci script (#803) 2018-10-15 18:52:37 +08:00
Michael Bryan b1c7c54108
Rewrote a large proportion of the Preprocessor docs to be up-to-date 2018-09-25 19:48:20 +08:00
mwilbur e4eddb3f26 Fix broken link to API pages (#795) 2018-09-19 23:32:37 +08:00
Ramon Buckland 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
Matt Ickstadt a9f3be6f44 Make serve command note more prominent 2018-09-06 10:24:56 -05:00
Matt Ickstadt 34356b87a0 Document dest-dir relative path behavior 2018-09-06 10:24:42 -05:00
Danny Guo d9c1c77aae
Fix a typo 2018-08-20 23:48:18 -04:00
Matt Ickstadt 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
Matt Ickstadt a8a460545f Update installation instructions in guide 2018-08-02 21:19:47 -05:00
Matt Ickstadt f30ce0184d Fix escaped link preprocessor 2018-08-02 19:04:35 -05:00
Matt Ickstadt a776aa9783 Update documentation for commands 2018-08-02 17:01:47 -05:00
Matt Ickstadt 8cd7061ff2 Add search.enable config field 2018-07-23 12:08:04 -05:00
Ganesh Prasad Kumble 21c24c2815
- Fix token type 
OAuth token type doesn't work. Have to change it to PAT.
 2018-07-21 19:23:47 +05:30
cetra3 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
Nick Fitzgerald 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
Weihang Lo 41d372de26 Update documentation for preprocessor (#686) 2018-05-06 23:48:11 +08:00
Weihang Lo 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
Davide Aversa 38279deed7 Add a note in MathJax documentation 2018-04-03 10:17:06 +02:00
Matt Ickstadt b2ad669c61 Search with Elasticlunr, updated (#604) 
* Add search with elasticlunr.js

This commit adds search functionality to mdBook, based on work done by @phaiax. The in-browser search code uses elasticlunr.js to execute the search, using an index generated at book build time by elasticlunr-rs.

* Add generator comment
Someone on Reddit was wondering how the rust book was generated and said they checked the source. Thought I'd put this here. Might be a good idea to have a little footer "made with mdBook", but this'll do for now.

* Remove search/editor file override behavior

* Use for loop for book iterator

* Improve HTML regex

* Fix search CORS in file URIs

* Use ammonia to sanitize HTML

* Filter html5ever log messages
 2018-03-07 21:02:06 +08:00
Sebastian Thiel bb043ef660 Add complete preprocessor example (#629) 
* First version of preprocessor example, with quicli

It seems it's not worth it right now.

* Remove quicli, just to simplify everything

* Finish de-emphasise example

* Finish preprocessor example in book

* Rename preprocessor type

* Apply changes requested in review

* Update preprocessor docs with latest code

[skip CI]
 2018-02-24 18:14:52 +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
bchatard 03c6c44e5b Fix typo in format configuration 2018-02-05 13:01:17 +01:00
Tshepang Lekhonkhobe 5d42738a79
doc: small fixes 2018-02-01 03:29:39 +02:00
boxdot bf9f58e11b Add docs for mdBook specific include feature (#593) 
* Add docs for mdBook specific include feature.

Also:
* Fix bug in take_lines taking `end`-many lines instead of
  `end-start` many.
* Handle special case `include:number` as including a single line.
* Start counting lines at 1 and not 0.

* Merge mdBook and rust specific features into one chapter.
 2018-01-31 18:57:47 +08:00
Michael Bryan 30e3b83167
Updated Cargo.toml metadata to make releases easier (#584) 2018-01-26 01:11:32 +08:00
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