Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2024-12-15 15:22:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
1813 commits 9 branches 95 tags 24 MiB
Commit graph

1015 commits

Author SHA1 Message Date
Eldred Habert
3ee22fb430
Apply max width to video as well as images 
Since videos are essentially animated images, this same max width makes sense for both.
 2021-05-23 16:10:26 +02:00
Eric Huss
16c5ec4d74 Remove chapter_begin id from print output. 2021-05-22 15:12:54 -07:00
Eric Huss
7e7e779ef7
Merge pull request #1526 from apatniv/add_log_messages 
Add useful messages when command line preprocessor fails
 2021-05-21 10:06: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
78325aaccb report book.toml parse errors 
check config for book parse errors

add invalid_title_type

handle build and rust config errors
 2021-05-19 09:32:24 -07:00
apatniv
b21446898a Add useful messages when command line preprocessor fails 2021-05-08 12:48:57 -04: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
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
Guillaume Gomez
c1d982d92b Remove duplicate "name" attribute on input 2021-04-24 17:27:49 +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
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
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
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
1a0c296532
Merge pull request #1426 from ehuss/search-mark-words 
Fix search highlighting with multiple words.
 2021-01-14 17:01:52 -08:00
Eric Huss
9b4ab72a80
Merge pull request #1418 from ehuss/relative-renderer-command 
Fix relative paths for renderer commands.
 2021-01-14 17:01:41 -08:00
Eric Huss
cdea0f6b61 Add missing parenthesis in doc comment. 2021-01-13 14:26:14 -08:00
pierwill
e9b0be7090 Add intra-docs links to docs 
Also fixes some punctuation and changes some wording.
 2021-01-10 14:51:30 -08:00
Tatsuya Kawano
d402a12e88 Skip HTML comments in the summary 2021-01-08 18:16:03 +08:00
Eric Huss
77e7cfd22b
Change init --theme to place theme in root. (#1432) 2021-01-07 01:29:38 +01:00
Eric Huss
09e7bb76dc
Remove mark from URL on escape. (#1427) 2021-01-05 19:31:16 +01:00
Eric Huss
28387130c0 Fix search highlighting with multiple words. 2021-01-04 14:20:36 -08:00
Eric Huss
33d3d9c3ec
Merge pull request #1389 from avitex/search-chapter-name 
Add chapter name to search result breadcrumbs
 2021-01-04 14:01:30 -08:00
Alexandru Macovei
beec17e55d Add ability to generate shell completions via clap 2021-01-04 23:51:02 +02:00
Eric Huss
e651f4d734
Merge pull request #1420 from apatniv/clippy_remove_clone 
Clippy lint: Remove unnecessary clone
 2021-01-04 11:33:37 -08:00
Eric Huss
87d2cd9845
Merge pull request #1421 from apatniv/clippy_use_single_char 
clippy: use char instead of str
 2021-01-04 11:31:06 -08:00
Pietro Albini
32abeef088 fix xss in the search page 
Thanks to Kamil Vavra for responsibly disclosing the vulnerability
according to Rust's Security Policy.
 2021-01-04 07:14:57 -08:00
apatniv
95e0743bc0 clippy: use char instead of str 2020-12-31 15:37:34 -05:00
apatniv
3c97525743 Clippy lint: Remove unnecessary clone 2020-12-31 15:18:37 -05:00
Eric Huss
9a65c8ab92 Fix relative paths for renderer commands. 2020-12-30 17:46:29 -08:00
francis-du
fd4137a9ea fix: readerer get theme dir path bug 2020-12-28 09:20:23 -08:00
Vivek Bharath Akupatni
a3d4febe3e
Provide useful feedback if user executes command in different folder (#1407) 
Provides better feedback if user executes in a different folder than what is expected by mdbook

After the changes `mdbook build`
```
2020-12-19 14:27:35 [ERROR] (mdbook::utils): Error: Couldn't open SUMMARY.md in "/Users/vicky/rust/source_codes/mdbook_testing/src/src" directory
2020-12-19 14:27:35 [ERROR] (mdbook::utils):    Caused By: No such file or directory (os error 2)
```

Previously: `mdbook build`
```
2020-12-19 14:28:46 [ERROR] (mdbook::utils): Error: Couldn't open SUMMARY.md
2020-12-19 14:28:46 [ERROR] (mdbook::utils):    Caused By: No such file or directory (os error 2)
```
 2020-12-27 12:45:11 -08:00
Eric Huss
cf2459f730
Merge pull request #1393 from apatniv/fixing_error 
Missing chapters Error Reporting: Add file name
 2020-12-14 08:33:36 -08:00
Kousuke Takaki
6bcabcbb6b Improve error message 2020-12-14 16:11:01 +09:00
apatniv
ef993e8cc2 Run rust formmater 2020-12-05 20:27:03 -05:00
apatniv
a3a5386da0 Add more context regarding which missing file creation failed 2020-12-05 20:17:45 -05:00
avitex
942cc12a74
Add chapter name to search result breadcrumbs 2020-11-25 14:46:49 +11:00
Eric Huss
552e3378cf
Merge pull request #1378 from daynin/serialize-build-section 
allow to serialize the "build" section
 2020-11-12 10:41:12 -08:00
Sergey Golovin
7c0ddff96a allow to serialize the "build" section 2020-11-12 19:32:32 +03:00
Eric Huss
07e72757d3
Merge pull request #1376 from dtolnay/html 
Escape `<` and `>` in rendered toc to match handlebars' escaping in <title>
 2020-11-10 14:46:24 -08:00
Eric Huss
58f66a146d
Merge pull request #1375 from dtolnay/playground 
Fix stray spacing after #playground code
 2020-11-10 14:06:09 -08:00
Eric Huss
643d5ecc5c
Merge pull request #1285 from FrankHB/patch-1 
Handled UTF-8 BOM
 2020-11-10 14:02:01 -08:00
David Tolnay
c712ba7aab
Escape <> in rendered toc 2020-11-08 22:26:30 -08:00
David Tolnay
1450070f73
Fix stray spacing after #playground code 2020-11-05 21:43:04 -08:00
FrankHB
9e9cf49c50 Added a test. 
Signed-off-by: FrankHB <frankhb1989@gmail.com>
 2020-10-07 22:50:25 +08:00
FrankHB
780fb979a0 Avoided the redundant allocation. 
Signed-off-by: FrankHB <frankhb1989@gmail.com>
 2020-09-29 18:01:06 +08: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
Eric Huss
e6ac8ecdd9 Fix print icon. 2020-09-22 13:24:13 -07:00
Ross MacArthur
e0b247e9d6 Add config option to disable print html, css, and icon 2020-09-22 11:40:02 -07:00
ifeanyi
b349e8abc9 Fix windows typo 2020-09-09 17:57:45 +02:00
ifeanyi
e225586953 Resolve full file paths when copying files 
Currently, the `copy_files` function doesn't support symlink files due to
its use of `DirEntry::metadata` - To avoid this issue, this patch
resolves the file path first before checking for metadata.

Fixes #1157
 2020-09-09 17:42:14 +02:00
Eric Huss
4df9ec90af
Merge pull request #1307 from camelid/prefer-bundled-scp 
Prefer bundled version of Source Code Pro
 2020-09-06 10:58:23 -07:00
Camelid
73cabeb904
Remove local version from @font-face 
It's unlikely that the bundled version wouldn't load, and it's
especially unlikely that the page would load but the bundled version
would not.

Also, if it doesn't load, it should fall back to another monospace font,
which is fine.
 2020-09-06 10:34:11 -07:00
Eric Huss
4b773024ae
Merge pull request #1309 from nerosnm/add-missing-space 
Fix missing space before draft chapter titles
 2020-09-06 09:40:55 -07:00
Eric Huss
33ea661350
Merge pull request #1310 from dtolnay/nojekyll 
End .nojekyll file with newline
 2020-09-06 09:21:59 -07:00
Eric Huss
1b18740b56
Merge pull request #1311 from dtolnay/cname 
Support emitting CNAME file for publishing at a custom domain
 2020-09-06 09:21:29 -07:00
Eric Huss
fd59dc73e5
Adjust wording 2020-09-06 09:11:53 -07:00
Gus Wynn
5ea8e55aea collect all test failures before failing 2020-09-03 18:36:51 -07:00
David Tolnay
1acf23ff73
Support emitting CNAME file for publishing at a custom domain 2020-09-02 11:24:48 -07:00
David Tolnay
69cc1fa005
End .nojekyll file with newline 
Before:

    /path/to$  cat book/.nojekyll
    This file makes sure that Github Pages doesn't process mdBook's output./path/to$  ▎

After:

    /path/to$  cat book/.nojekyll
    This file makes sure that Github Pages doesn't process mdBook's output.
    /path/to$  ▎
 2020-09-02 11:06:19 -07:00
Søren Mortensen
2fb489137b
Wrap draft chapter titles in a <div> 
Fixes the problem of a missing space before the title of draft chapters,
due to the title not being wrapped in an `<a></a>`.
 2020-08-31 10:00:03 +01:00
Camelid
4d9eb9b4b4 Prefer bundled version of Source Code Pro 
This prevents an issue with Firefox 80 on macOS that prevents syntax
highlighting from working.
 2020-08-29 13:22:51 -07:00
Eric Huss
3d44553671
Merge pull request #1293 from Evian-Zhang/master 
allow space in SUMMARY.md's link destination
 2020-08-08 08:19:06 -07:00
Evian-Zhang
9d5c454e47 delete '+' replacement and use cargo fmt to format 2020-08-08 15:13:22 +08:00
Eric Huss
a00e7d1769
Merge pull request #1272 from ehuss/fix-favicon-link 
Fix favicon when only one is overridden.
 2020-08-07 08:34:46 -07:00
Evian-Zhang
60be20a783 allow space in SUMMARY.md's link destination 2020-08-03 09:49:01 +08:00
Eric Huss
8746206060
Merge pull request #1284 from ericonr/opt 
Mention that uninstalled backend isn't marked optional.
 2020-07-30 20:22:55 -07:00
Érico Rolim
dcf9462d1e summary: turn SoftBreak events into spaces. 
Summary items that had their name split into two lines ended up with the
last word of one line and the first word of the next line glued
together, since a space wasn't added.

Added test case for it.

Fixes #1218
 2020-07-29 15:53:27 -03:00
Érico Rolim
78aa2a16f8 Mention that uninstalled backend isn't marked optional. 
If an uninstalled backend (command not found) isn't marked optional,
warn about it, since it causes mdbook commands to error out.

Fixes #1283
 2020-07-28 18:08:32 -03:00
FrankHB
65d9eb6f7e
Handled UTF-8 BOM 
Fixed #1155 .
 2020-07-25 13:02:44 +08:00
Eric Huss
303db0ddec
Merge pull request #1277 from maniyar1/patch-1 
Update highlight.js
 2020-07-21 14:17:03 -07:00
maniyar1
60029e4e15
Add R-lang support 2020-07-20 19:03:29 -04:00
Owen Nelson
0eefd63a13 Change "show hidden lines" icon to "eye" instead of "expand." 
In a recent discussion in the amethyst docs discord channel,
it was suggested that using an "eye" icon might make the show hidden
lines feature of mdbook's code sample rendering more discoverable.

I myself overlooked the arrows that are in use now.

Fixes #663 at least in part.
 2020-07-16 19:27:18 -07:00
maniyar1
c99047bbda
Update highlight.js 
Updates to 10.1.1, with support for new languages added to the common set.
Built with:
common languages + D, handlebars, haskell, julia, scala, x86asm, armasm, yaml
Size difference:
New highlight.js: 132KiB
Old highlight.js: 84KiB
--
New highlight.js compressed: 48KiB
Old highlight.js compressed: 36KiB
 2020-07-09 14:01:51 -04:00
Eric Huss
20a0b99c3d Fix favicon when only one is overridden. 
A mistake in #1266, I neglected to also update the <link> generation
to elide the link if one of the favicon images is not included.
 2020-07-08 12:44:07 -07:00
Eric Huss
649f3555e5
Merge pull request #1266 from ehuss/favicon-no-default 
Don't copy default favicon if at least one is overridden.
 2020-07-03 08:47:34 -07:00
Eric Huss
b0c6f2d7a3 Don't copy default favicon if at least one is overridden. 2020-06-27 16:30:46 -07:00
Eric Huss
e9951af73e Fix sidebar scrolling with part titles. 2020-06-24 21:13:02 -07:00
Eric Huss
4699269e49 Add SVG favicon. 2020-06-23 10:58:10 -07:00
Eric Huss
f59cfe7e2f Fix dest-dir command-line flag. 2020-06-23 10:55:01 -07:00
Eric Huss
9268884b17
Merge pull request #1221 from manuel-woelker/fb-539-not-found-page 
Generate 404.html page (#539)
 2020-06-23 10:48:08 -07:00
Eric Huss
4f435c62e6
Merge pull request #1249 from ThePuzzlemaker/thepuzzlemaker-stylepatch 
Fix issue where Font Awesome overrides `.hidden`'s `display: none`
 2020-06-22 12:28:09 -07:00
Eric Huss
9a97f0a096
Fix init creating empty [rust] table. (#1233) 2020-06-22 16:36:37 +02:00
Eric Huss
bc23d08fa5
Rename playpen to playground. (#1241) 
looks good
 2020-06-22 16:34:25 +02:00
ThePuzzlemaker
84d848f292
Fix issue where Font Awesome overrides .hidden's display: none 2020-06-10 12:55:22 -05:00
Manuel Woelker
d7df832cce fix test and formatting 2020-06-10 15:33:09 +02:00
Manuel Woelker
406b325c54 fix usage of newly stablized inner_deref/as_deref 2020-06-10 13:09:18 +02:00
Manuel Woelker
06efa7a675 additional changes to the 404 mechanism based on feedback: 
- removed config output_404
 - ensure serve overrides the site url, and hosts the correct 404 file
 - refactor 404 rendering into separate fn
 - formatting
 2020-06-10 12:46:23 +02:00
Manuel Woelker
bff36e7229 Add the config parameter output.html.site-url to set base url of the 404 page, making links and relative script/css loads behave correctly even in subdirectory paths 2020-06-10 12:46:23 +02:00
Manuel Woelker
cda28bb618 Generate 404.html page (#539) 2020-06-10 12:46:23 +02:00
Eric Huss
23f5ffd6d6 Change default preferred-dark-theme to navy. 2020-06-08 11:40:38 -07:00
Bryce Fisher-Fleig
fb1476d1e3
fix: don't jump away from form input to search bar 
Addresses #1020 with the suggestion from prior PR #1101
 2020-06-04 14:35:49 -07:00