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

144 Commits

Author SHA1 Message Date
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
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
Spencer Burris 4615ce2f8c Remove --debug from GitLab CI 2020-12-04 09:12:00 -08:00
Spencer Burris d1721667b6 Add instructions for publishing via GitLab Pages 2020-12-01 13:25:28 -08:00
A Ho 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
A Ho e310dfc605
Add avisionh to contributors 
This is for contributing to the travis deployments chapter.
 2020-11-05 22:28:54 +00:00
A Ho 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
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