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

2211 Commits

Author SHA1 Message Date
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
Eric Huss d62cf8e883
Merge pull request #1520 from apatniv/patch-1 
Add entry to contributor section
 2021-05-05 08:32:23 -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
Eric Huss 84b3b7218e
Merge pull request #1437 from rust-lang-ja/summary-with-html-comments 
Skip HTML nodes in SUMMARY.md
 2021-05-04 07:26:03 -07:00
Eric Huss 71ba6c9eb8
Merge pull request #1514 from c-cube/patch-1 
more detailed example in summary.md
 2021-05-03 17:46:56 -07: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
josh rotenberg 5b7abf4714 add semver v0.11.0 for example 2021-04-26 08:08:53 -07:00
josh rotenberg d0ef70e574 use semver to validate version 2021-04-26 08:08:24 -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
Eric Huss b54e73e3b6
Merge pull request #1509 from GuillaumeGomez/duplicate-name 
Remove duplicate "name" attribute on input
 2021-04-25 20:08:55 -07: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
Guillaume Gomez c1d982d92b Remove duplicate "name" attribute on input 2021-04-24 17:27:49 +02:00
syntezoid 3db275d68a
Change in gitlab CI (#1507) 2021-04-23 11:51:42 +02:00
Flavio Castelli 94e797fba0
mdbook book: show edit link 
Add "edit" links to the pages of mdbook own book
 2021-04-19 19:08:15 +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
Flavio Castelli 7aff98a859
Fix generation of edit links 
The `IndexPreprocessor` rewrites the path for files
named `README.md` to be `index.md`. This breaks the edit link
in some circumstances.

To address this issues, the `Chapter` struct has now a new attribute
called `source_path`. This is initialized with the same value as
`path`, but is never ever changed.

Finally, the edit link is built by using the `source_path` rather
than the `path`.
 2021-04-19 18:58:15 +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 dcc642e66d
[ReviewFix] cargo fmt 2021-04-19 14:51:16 +02:00
Jonas Berlin 2b738d4425
[ReviewFix] Fix variable naming 2021-04-19 14:51:16 +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
Tatsuya Kawano 30ce7e79ac Skip HTML comments in the summary 
- Revert changes in parse_numbered(). They were unnecessary.
 2021-04-05 18:31:11 +08: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
Eric Huss e6568a70eb
Merge pull request #1485 from Evian-Zhang/add-pagebreak 
Add page-break
 2021-03-17 09:45:30 -07:00
Evian-Zhang 0eb23efd44 Make page-break not configurable 2021-03-16 09:33:19 +08:00
Evian-Zhang e78a8471c7 Add page-break option 2021-03-12 14:00:29 +08: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
Eric Huss 536873ca26
Merge pull request #1478 from camelid/patch-1 
docs: Use inline code for regex
 2021-03-01 08:15:20 -08: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
Eric Huss 3f39ba82f9
Merge pull request #1474 from ehuss/bump-version 
Update to 0.4.7
 2021-02-22 15:44:42 -08:00
Eric Huss 7da38715c1 Update to 0.4.7 2021-02-22 14:56:44 -08:00
Eric Huss c83bbd6319
Merge pull request #1463 from ehuss/fix-header-scroll 
Fix some issues with fragment scrolling and linking.
 2021-02-22 14:50:17 -08:00
Eric Huss fad3c663f4
Merge pull request #1461 from ehuss/guide-repo-link 
Add git repository url link to user guide.
 2021-02-22 14:50:05 -08:00
Eric Huss f8b9054265
Merge pull request #1470 from tim-seoss/light_theme_contrast_enhancement 
Enhance text contrast of `light` theme to improve accessibility.
 2021-02-22 14:49:07 -08:00
Fenhl f26116a491
Upgrade to shlex 1 (#1471) 2021-02-22 00:15:16 +01:00
Tim Small 7f59fdd9bd Enhance text contrast of `light` theme to improve accessibility. 
The existing light theme has relatively low contrast between the text
(and other UI elements) and background (especially within code blocks).
This presents difficulties for people with reduced visual contrast
perception (common in older adults).

This patch makes changes to the default `light` theme to meet the
minimum contrast requirement of the v2.1 W3C WCAG (Web Content
Accessibility Guidelines)
https://www.w3.org/WAI/WCAG21/quickref/#contrast-minimum

The small size, and slender font used for the title text makes it hard
to read, even with the increased contrast colour scheme, so this patch
also increases the size of the title text font by 20%.

Closes #1442
 2021-02-21 14:35:10 +00:00
Eric Huss 45d41eac5f Fix some issues with fragment scrolling and linking. 2021-02-12 16:37:07 -08:00
Eric Huss 2b5890e2ed Add git repository url link to user guide. 2021-02-12 07:34:20 -08:00
Eric Huss 0b9570b160
Merge pull request #1456 from danieleades/typo 
fix small typos on 'syntax-highlighting' page
 2021-01-30 09:09:37 -08: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 9a9eb0124a
Merge pull request #1447 from ehuss/bump-version 
Update to 0.4.6.
 2021-01-14 17:36:08 -08:00