Eric Huss
c2d973997a
Make fonts part of the theme.
2023-01-15 11:42:46 -08:00
Eric Huss
9764f8886b
Fix MDBOOK_BOOK environment variable example
2022-12-28 19:21:38 -08:00
Eric Huss
dec487c62b
Update to 0.4.25
2022-12-17 07:42:00 -08:00
Eric Huss
294aad092e
Update to 0.4.24
2022-12-15 06:55:05 -08:00
Eric Huss
219362318c
Update to 0.4.23
2022-12-14 17:48:46 -08:00
Eric Huss
fb0af12433
Bump MSRV to 1.60
...
Needed for new feature syntax
2022-12-14 07:20:09 -08:00
klensy
21fb329d56
fix msrv in docs
2022-11-29 20:33:03 +03:00
Eric Huss
ded48ddac7
Update to 0.4.22
2022-11-28 09:54:39 -08:00
Will Crichton
144a1e4009
Add documentation for extra-watch-dirs
2022-11-12 14:28:43 -08:00
Chris Lovett
74eb4059d6
add a --chapter option to mdbook test. ( #1741 )
...
Sometimes when working on large books it is handy to be able to run mdbook on a single chapter of a book.
2022-08-25 19:13:51 -07:00
Joep Meindertsma
b3941526cb
Explain how to use `site-url`
...
Make sure people use the right kind of asset-urls. This issue only shows up when deploying, not using `mdbook serve`.
2022-08-23 10:33:25 +02:00
Eric Huss
bb09caa9a3
Update to 0.4.21
2022-07-22 10:54:53 -07:00
Eric Huss
4c1aca0abb
Update to 0.4.20
2022-07-14 13:46:56 -07:00
Fauconfan
a8a45a5fbe
authors -> author in user guide
2022-07-09 15:31:00 +02:00
Eric Huss
04e31eb07b
Update to 0.4.19
2022-07-01 14:55:25 -07:00
Eric Huss
1d89127d8f
Mention how to uninstall.
...
Closes #1822 .
2022-06-27 11:10:09 -07:00
Eric Huss
268dbb099f
Update to 0.4.18
2022-04-15 11:24:45 -07:00
sgoudham
8e1195322a
Fix typo 'mbdook' to 'mdbook'
2022-04-01 13:13:58 +01:00
Eric Huss
445529a68f
Update to 0.4.17
2022-03-30 09:33:56 -07:00
Eric Huss
adf6129769
Update to 0.4.16
2022-03-29 17:33:01 -07:00
Eric Huss
7c37dd5e85
Merge pull request #1731 from epage/clap3
...
Port mdBook to clap3
2022-03-28 12:34:17 -07:00
Ed Page
44f982f8e5
chore: Upgrade MSRV
2022-03-28 13:06:44 -05: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
Pi Delport
50bad7f983
style: add missing word
2022-02-22 18:00:41 +02:00
Daniel Morawetz
9e6217871e
add page-break option to docs
2022-01-17 18:07:22 +01:00
Eric Huss
b0511f408d
Update to 0.4.15
2022-01-04 10:18:39 -08: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
josh rotenberg
b38949a408
add a markdown page
2021-12-17 19:08:21 -08:00
josh rotenberg
c32869cf10
moving this to the markdown page
2021-12-17 19:08:03 -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
Eric Huss
f55028b61a
Merge pull request #1657 from lclc/gitlabPages
...
Documentation: CI: GitLab Pages Example
2021-10-03 14:51:08 -07:00
Lucas Betschart
b862080006
Documentation: CI: GitLab Pages Example
...
Replace 'only' with 'rules'.
'only' is not actively developed anymore with GitLab (see https://docs.gitlab.com/ee/ci/yaml/#only--except )
2021-09-29 12:42:15 +02: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
63680d0786
Merge pull request #1480 from pauliyobo/preprocessor_docs
...
Improving documentation on implementation of preprocessors.
2021-09-05 18:46:09 -07:00
Eric Huss
656a1825cc
Minor fixes for preprocessor docs.
2021-09-05 18:45:37 -07:00
pauliyobo
1a2fa29209
introduced proposed suggestions related to the documentation
2021-09-04 23:44:27 +02:00
Wojciech Kępka
981f8695ff
Add information about a new backend `mdbook-man`
2021-08-26 17:45:22 +02:00
Eric Huss
68d8ceec47
Revert #1597 - Update to highlight.js 11.0.
2021-08-02 08:02:13 -07:00
josh rotenberg
5e277140be
add a couple, clean up a little
2021-07-26 21:23:42 -07:00
Eric Huss
6dd785ea6c
Update to highlight.js 11.0.
2021-07-26 12:40:28 -07:00
josh rotenberg
49b75810fa
fix a few typos
2021-07-24 21:17:41 -07:00
josh rotenberg
b85d5eb455
updates to the mdbook introduction
2021-07-24 18:41:53 -07:00
Eric Huss
56652e8fa6
Merge pull request #1559 from joshrotenberg/title_ignore_flags_init
...
Add --title option and --gitignore flag to mdbook init
2021-07-06 09:22:38 -07:00
Eric Huss
c3a1e41ed7
Update CLI docs for flag name change.
2021-07-06 09:22:05 -07:00
Eric Huss
3976c9d8f0
Merge pull request #1576 from kana4/master
...
MyPaths are not required and fail
2021-07-06 08:59:54 -07:00
josh rotenberg
c06f450e7d
add edition2021 as an option
2021-07-04 16:28:52 -07:00
kana
a8926d5392
Update continuous-integration.md
2021-07-04 18:28:56 +01:00
kana
00473d8420
Add comments to edit in case of custom book path
2021-07-04 18:27:53 +01:00
Eric Huss
b3c0b01350
Merge pull request #1586 from joshrotenberg/fix_library_path_doc
...
Clarify the library path documentation
2021-07-04 07:41:42 -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
josh rotenberg
9fd2509c0d
fix link
2021-06-25 08:24:57 -07:00
josh rotenberg
5dec8508c7
clarify the library path documentation
2021-06-24 19:08:23 -07: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
kana
27b1e05c87
MyPaths are not required and fail
...
Inputting paths are not necessary and will break ci, we can just leave paths out. We also changed 'master' to main since anyone reading this is probably going to be making mains
2021-06-11 20:21:28 +01: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
e5e10c681a
add init flags
...
add init flags
update init command in guide
2021-05-31 20:47:51 -07:00
Eric Huss
836546cf0d
Merge pull request #1544 from joshrotenberg/guide_configuration_restructure
...
Restructure guide configuration section
2021-05-29 14:46:58 -07:00
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
Eldred Habert
89a2e39b80
Mention missing file creation in build/watch/serve's docs ( #1548 )
...
Fixes #1246
2021-05-25 13:45:30 +02: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
josh rotenberg
c922b8aae6
backquote port
2021-05-08 09:51:30 -07:00
josh rotenberg
f4b4a331d7
consisten note format, update gitignore language
2021-05-07 21:02:55 -07:00
josh rotenberg
aa349e0b7c
update serve documentation
2021-05-07 20:29:01 -07:00
Eric Huss
b592b10633
Merge pull request #1519 from tshepang/patch-1
...
Update init.md
2021-05-05 08:32:52 -07:00
Vivek Bharath Akupatni
c6844dd771
Add entry to contributor section
2021-05-05 08:42:43 -04:00
Tshepang Lekhonkhobe
009247be01
Update init.md
...
make sentence more simple
2021-05-05 12:06:56 +02: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
Eric Huss
a72d6002b7
Merge pull request #1506 from flavio/feature/suggest-an-edit-link
...
Feature/suggest an edit link
2021-04-26 11:03:50 -07: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
josh rotenberg
59c76fa665
Reword incomplete sentence in Preprocessors section in the guide ( #1510 )
...
* fix and reword incomplete sentence
* remove unused reference
2021-04-26 01:18:57 +02:00
syntezoid
3db275d68a
Change in gitlab CI ( #1507 )
2021-04-23 11:51:42 +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
Paul
dcccd3289d
Apply suggestions from code review
...
improved readability and cleared sections which could have caused more confusion
Co-authored-by: Eric Huss <eric@huss.org>
2021-03-08 20:39:39 +01:00
pauliyobo
5637a66459
hopefully made the documentation more clearer on what concerns preprocessor implementation with non rust languages
2021-03-05 21:11:29 +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
24b76dd879
Fix sentence on installation page.
2021-01-15 07:50:06 -08:00
Eric Huss
3d55375f61
Update theme CSS docs. ( #1431 )
2021-01-07 01:56:20 +01:00
Eric Huss
76cd39e5e2
Merge pull request #1390 from sburris0/gitlabci
...
Guide: Add instructions for publishing via GitLab Pages
2021-01-06 13:11:58 -08:00