Commit Graph

44 Commits

Author SHA1 Message Date
Fauconfan a8a45a5fbe authors -> author in user guide 2022-07-09 15:31:00 +02:00
Shogo Takata 2ae7f007cc
add doc in mdbook.md 2022-03-27 17:28:42 +09:00
Shogo Takata 89e37a7751
add docs 2022-03-26 16:11:41 +09:00
Daniel Morawetz 9e6217871e
add page-break option to docs 2022-01-17 18:07:22 +01:00
Eric Huss f2fba30786 Update documentation 2021-12-19 20:26:37 -08:00
Eric Huss f3e5fce6bf
Merge pull request #1709 from joshrotenberg/markdown-page
Markdown page
2021-12-19 13:26:41 -08:00
josh rotenberg 2d36cd9263 more markdown 2021-12-18 16:00:46 -08:00
josh rotenberg 09087097b5 add more sections here 2021-12-18 15:50:51 -08:00
josh rotenberg 18b9f42fba add the markdown page 2021-12-17 19:08:58 -08:00
Eric Huss e3e170715e
Merge pull request #1706 from vaporup/patch-1
Fix Typo in summary.md
2021-12-16 13:53:22 -08:00
Sven Wick 4e03818f3e
Update summary.md 2021-12-16 18:29:47 +01:00
Alessandro Coglio 3f268cb0df
Fix typo. 2021-12-15 20:53:01 -08:00
josh rotenberg 191dccab10
fix typo 2021-12-06 08:06:07 -08:00
Eric Huss c3ff4a5129 Deprecate google-analytics. 2021-10-24 11:43:37 -07:00
ISSOtm 6b784be616 Stabilize ties in preproc order through name sort 2021-09-27 21:28:01 +02:00
ISSOtm 9c34e602bd Allow specifying preprocessor order
Fixes #1172
2021-09-26 20:55:02 +02:00
Eric Huss 68d8ceec47 Revert #1597 - Update to highlight.js 11.0. 2021-08-02 08:02:13 -07:00
Eric Huss 6dd785ea6c Update to highlight.js 11.0. 2021-07-26 12:40:28 -07:00
josh rotenberg c06f450e7d add edition2021 as an option 2021-07-04 16:28:52 -07:00
Frits Stegmann 7932e13512
Update renderers.md
I was doing some work on the epub plugin repo and when trying to build an epub I came across what looked like some broken references.
2021-07-04 08:12:18 +02:00
Tuyen Pham efb13d7bc1
Fix inconsistent between bash version and rust version of the sample
In the bash version, `y` have value 6, while rust version it has value 7
2021-06-19 20:08:27 +07:00
Eric Huss b899c48019
Merge pull request #1566 from joshrotenberg/markdown_list_clarification
Documentation clarification on markdown list markers
2021-06-07 15:30:21 -07:00
josh rotenberg 515a253e97 doc clarification on markdown list markers
doc clarification on markdown list markers

shorten
2021-06-06 18:59:53 -07:00
Atharva Raykar fa3ae53d46
Fix typo in documentation
a very pedantic ommitted -> omitted
2021-06-05 22:50:45 +05:30
josh rotenberg aa4cb9465f restructure guide configuration section
restructure guide configuration section

restructure guide configuration section

redirect to new config top level

fix broken links

use a relative path for redirect

Co-authored-by: Eric Huss <eric@huss.org>

remove extra heading
2021-05-25 07:43:36 -07:00
Andrea Gelmini b364e8ea2c
Fix typos (#1540)
Signed-off-by: Andrea Gelmini <andrea.gelmini@gelma.net>
2021-05-21 12:56:32 +02:00
josh rotenberg d147a85006 summary.md updates 2021-05-14 22:05:24 -07:00
Andrew Morgan 379574dc61
Fix a small typo
misssing -> missing
2021-05-13 23:55:51 +01:00
Simon Cruanes 9d4ee689db
Update guide/src/format/summary.md
Co-authored-by: Eric Huss <eric@huss.org>
2021-05-03 20:16:11 -04:00
Simon Cruanes ffe88d7e29
Update guide/src/format/summary.md
Co-authored-by: Eric Huss <eric@huss.org>
2021-05-03 20:16:05 -04:00
Simon Cruanes 9f930706bb
Update guide/src/format/summary.md
Co-authored-by: josh rotenberg <joshrotenberg@users.noreply.github.com>
2021-05-02 21:21:41 -04:00
Simon Cruanes 24fa615149
more detailed example in summary.md
this shows a richer structure of numbered chapters to better illustrate that it uses nested markdown lists.
2021-05-02 11:27:28 -04:00
Flavio Castelli 7525b35383
Rename git-repository-edit-url-template
Change the name of the git-repository-edit-url-template to be more
generic: `edit-url-template`

Signed-off-by: Flavio Castelli <fcastelli@suse.com>
2021-04-26 09:59:08 +02:00
Flavio Castelli c3beecc96a
Update docs to include example of edit links feature
Add a working example of the edit links feature to the examples
2021-04-19 19:07:37 +02:00
Jonas Berlin bbf54d7459
[ReviewFix] Replace edit baseurl with template and make visibility independent of git_repository_url. 2021-04-19 16:16:08 +02:00
Jonas Berlin b3670ece0e
Add "Suggest an edit" link next to "Git repository"
Includes new configuration option `git-repository-edit-baseurl` for
supporting non-GitHub repository layouts.
2021-04-19 14:51:14 +02:00
David Tolnay 94f7578576
Add page title override: {{#title My Title}} (#1381)
* Add page title override: {{#title My Title}}

* Document {{#title}} in guide
2021-03-24 02:36:45 +01:00
Camelid d6ea4e3f7a
docs: Use inline code for regex
And fix a typo.
2021-02-27 20:17:36 -08:00
mbartlett21 fcceee4761
Update examples with hidden lines (#1476)
* Update example.rs to have correct indent

The three hidden lines in example.rs now have four spaces indent for the hidden lines.

* Update mdbook.md
2021-02-27 02:40:14 +01:00
Daniel Eades 90396c5b76 fix small typos on 'syntax-highlighting' page 2021-01-30 08:11:45 +00:00
Eric Huss 3d55375f61
Update theme CSS docs. (#1431) 2021-01-07 01:56:20 +01:00
Maxime BORGES 6201e577fe
[guide/format/theme/index-hbs] `chapter_title` and `book_title` are inverted
Looking into the code, we can confirm that the implementation is `{{ chapter_title }} - {{ book_title }}` and not `{{ book_title }} - {{ chapter_title }}` as written in the guide:
4c951d530d/src/renderer/html_handlebars/hbs_renderer.rs (L69)
2020-12-22 22:36:58 +01:00
Camelid 4c951d530d
List supported Highlight.js languages in guide (#1345)
* List supported Highlight.js languages in guide

Generated using the technique described in
https://github.com/rust-lang/mdBook/issues/1275#issuecomment-655903967.

* Improve wording in guide
2020-09-30 01:56:31 +02:00
Camelid b77942d3c8
Rename `book-example` to `guide` (#1336)
`book-example` is a bit of a strange name given that it's not just an
example.
2020-09-23 03:16:09 +02:00