89e37a7751
add docs
2022-03-26 16:11:41 +09:00
50bad7f983
style: add missing word
2022-02-22 18:00:41 +02:00
9e6217871e
add page-break option to docs
2022-01-17 18:07:22 +01:00
b0511f408d
Update to 0.4.15
2022-01-04 10:18:39 -08:00
f2fba30786
Update documentation
2021-12-19 20:26:37 -08:00
f3e5fce6bf
Merge pull request #1709 from joshrotenberg/markdown-page
...
Markdown page
2021-12-19 13:26:41 -08:00
2d36cd9263
more markdown
2021-12-18 16:00:46 -08:00
09087097b5
add more sections here
2021-12-18 15:50:51 -08:00
18b9f42fba
add the markdown page
2021-12-17 19:08:58 -08:00
b38949a408
add a markdown page
2021-12-17 19:08:21 -08:00
c32869cf10
moving this to the markdown page
2021-12-17 19:08:03 -08:00
e3e170715e
Merge pull request #1706 from vaporup/patch-1
...
Fix Typo in summary.md
2021-12-16 13:53:22 -08:00
4e03818f3e
Update summary.md
2021-12-16 18:29:47 +01:00
3f268cb0df
Fix typo.
2021-12-15 20:53:01 -08:00
191dccab10
fix typo
2021-12-06 08:06:07 -08:00
c3ff4a5129
Deprecate google-analytics.
2021-10-24 11:43:37 -07:00
f55028b61a
Merge pull request #1657 from lclc/gitlabPages
...
Documentation: CI: GitLab Pages Example
2021-10-03 14:51:08 -07:00
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
6b784be616
Stabilize ties in preproc order through name sort
2021-09-27 21:28:01 +02:00
9c34e602bd
Allow specifying preprocessor order
...
Fixes #1172
2021-09-26 20:55:02 +02:00
63680d0786
Merge pull request #1480 from pauliyobo/preprocessor_docs
...
Improving documentation on implementation of preprocessors.
2021-09-05 18:46:09 -07:00
656a1825cc
Minor fixes for preprocessor docs.
2021-09-05 18:45:37 -07:00
1a2fa29209
introduced proposed suggestions related to the documentation
2021-09-04 23:44:27 +02:00
981f8695ff
Add information about a new backend `mdbook-man`
2021-08-26 17:45:22 +02:00
68d8ceec47
Revert #1597 - Update to highlight.js 11.0.
2021-08-02 08:02:13 -07:00
5e277140be
add a couple, clean up a little
2021-07-26 21:23:42 -07:00
6dd785ea6c
Update to highlight.js 11.0.
2021-07-26 12:40:28 -07:00
49b75810fa
fix a few typos
2021-07-24 21:17:41 -07:00
b85d5eb455
updates to the mdbook introduction
2021-07-24 18:41:53 -07:00
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
c3a1e41ed7
Update CLI docs for flag name change.
2021-07-06 09:22:05 -07:00
3976c9d8f0
Merge pull request #1576 from kana4/master
...
MyPaths are not required and fail
2021-07-06 08:59:54 -07:00
c06f450e7d
add edition2021 as an option
2021-07-04 16:28:52 -07:00
a8926d5392
Update continuous-integration.md
2021-07-04 18:28:56 +01:00
00473d8420
Add comments to edit in case of custom book path
2021-07-04 18:27:53 +01:00
b3c0b01350
Merge pull request #1586 from joshrotenberg/fix_library_path_doc
...
Clarify the library path documentation
2021-07-04 07:41:42 -07:00
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
9fd2509c0d
fix link
2021-06-25 08:24:57 -07:00
5dec8508c7
clarify the library path documentation
2021-06-24 19:08:23 -07:00
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
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
b899c48019
Merge pull request #1566 from joshrotenberg/markdown_list_clarification
...
Documentation clarification on markdown list markers
2021-06-07 15:30:21 -07:00
515a253e97
doc clarification on markdown list markers
...
doc clarification on markdown list markers
shorten
2021-06-06 18:59:53 -07:00
fa3ae53d46
Fix typo in documentation
...
a very pedantic ommitted -> omitted
2021-06-05 22:50:45 +05:30
e5e10c681a
add init flags
...
add init flags
update init command in guide
2021-05-31 20:47:51 -07:00
836546cf0d
Merge pull request #1544 from joshrotenberg/guide_configuration_restructure
...
Restructure guide configuration section
2021-05-29 14:46:58 -07:00
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
89a2e39b80
Mention missing file creation in build/watch/serve's docs ( #1548 )
...
Fixes #1246
2021-05-25 13:45:30 +02:00
b364e8ea2c
Fix typos ( #1540 )
...
Signed-off-by: Andrea Gelmini <andrea.gelmini@gelma.net>
2021-05-21 12:56:32 +02:00
d147a85006
summary.md updates
2021-05-14 22:05:24 -07:00
379574dc61
Fix a small typo
...
misssing -> missing
2021-05-13 23:55:51 +01:00
c922b8aae6
backquote port
2021-05-08 09:51:30 -07:00
f4b4a331d7
consisten note format, update gitignore language
2021-05-07 21:02:55 -07:00
aa349e0b7c
update serve documentation
2021-05-07 20:29:01 -07:00
b592b10633
Merge pull request #1519 from tshepang/patch-1
...
Update init.md
2021-05-05 08:32:52 -07:00
c6844dd771
Add entry to contributor section
2021-05-05 08:42:43 -04:00
009247be01
Update init.md
...
make sentence more simple
2021-05-05 12:06:56 +02:00
9d4ee689db
Update guide/src/format/summary.md
...
Co-authored-by: Eric Huss <eric@huss.org>
2021-05-03 20:16:11 -04:00
ffe88d7e29
Update guide/src/format/summary.md
...
Co-authored-by: Eric Huss <eric@huss.org>
2021-05-03 20:16:05 -04:00
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
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
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
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
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
3db275d68a
Change in gitlab CI ( #1507 )
2021-04-23 11:51:42 +02:00
94e797fba0
mdbook book: show edit link
...
Add "edit" links to the pages of mdbook own book
2021-04-19 19:08:15 +02:00
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
bbf54d7459
[ReviewFix] Replace edit baseurl with template and make visibility independent of git_repository_url.
2021-04-19 16:16:08 +02:00
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
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
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
5637a66459
hopefully made the documentation more clearer on what concerns preprocessor implementation with non rust languages
2021-03-05 21:11:29 +01:00
d6ea4e3f7a
docs: Use inline code for regex
...
And fix a typo.
2021-02-27 20:17:36 -08:00
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
2b5890e2ed
Add git repository url link to user guide.
2021-02-12 07:34:20 -08:00
90396c5b76
fix small typos on 'syntax-highlighting' page
2021-01-30 08:11:45 +00:00
24b76dd879
Fix sentence on installation page.
2021-01-15 07:50:06 -08:00
3d55375f61
Update theme CSS docs. ( #1431 )
2021-01-07 01:56:20 +01:00
76cd39e5e2
Merge pull request #1390 from sburris0/gitlabci
...
Guide: Add instructions for publishing via GitLab Pages
2021-01-06 13:11:58 -08:00
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
4615ce2f8c
Remove --debug from GitLab CI
2020-12-04 09:12:00 -08:00
d1721667b6
Add instructions for publishing via GitLab Pages
2020-12-01 13:25:28 -08:00
75d0f1efd4
Suggest dplyv2 changes to .travis.yml as a note
...
This is following @ehuss' comment to not recommend something currently in beta release.
2020-11-13 09:40:33 +00:00
e310dfc605
Add avisionh to contributors
...
This is for contributing to the travis deployments chapter.
2020-11-05 22:28:54 +00:00
cbfd75a821
Update CI section in guide for travis dpl-v2
...
This is so that the instructions work when deploying the book to GitHub pages via the gh-pages branch.
2020-11-05 21:43:52 +00:00
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
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
Shogo Takata
Pi Delport
Daniel Morawetz
Eric Huss
josh rotenberg
Sven Wick
Alessandro Coglio
Lucas Betschart
ISSOtm
pauliyobo
Wojciech Kępka
josh rotenberg
kana
Frits Stegmann
Tuyen Pham
Atharva Raykar
Andrea Gelmini
Andrew Morgan
Vivek Bharath Akupatni
Tshepang Lekhonkhobe
Simon Cruanes
Flavio Castelli
syntezoid
Jonas Berlin
David Tolnay
Paul
Camelid
mbartlett21
Daniel Eades
Maxime BORGES
Spencer Burris
A Ho
Camelid