8ec0bf6e30
ignore now takes a value
2021-07-04 11:57:46 -07:00
86d390032b
drop short flags
2021-07-04 08:15:51 -07:00
dc2062ab36
Merge pull request #1541 from ehuss/id-chapter_begin
...
Remove chapter_begin id from print output.
2021-06-08 14:55:06 -07:00
b59aab56f2
Revert "book: use non_exhaustive attribute for struct Book"
...
This reverts commit c1b2bec7d7
2021-06-08 12:46:27 -07:00
d325c601bb
Merge pull request #1554 from joshrotenberg/edit_url_custom_src
...
Use the configured book src directory for the edit url template path
2021-06-01 18:36:32 -07:00
e5e10c681a
add init flags
...
add init flags
update init command in guide
2021-05-31 20:47:51 -07:00
05edc4421b
clippy: PathBuf to Path
2021-05-31 20:27:52 -07:00
714c5fb81e
renderer: remove redundant clone in CmdRenderer
...
As suggested by clippy:
https://rust-lang.github.io/rust-clippy/master/index.html#redundant_clone
2021-05-30 19:33:46 +02:00
56ceb627b8
book: simplify is_draft_chapter
...
As suggested by clippy:
https://rust-lang.github.io/rust-clippy/master/index.html#redundant_pattern_matching
2021-05-30 19:33:46 +02:00
c1b2bec7d7
book: use non_exhaustive attribute for struct Book
...
As suggested by clippy:
https://rust-lang.github.io/rust-clippy/master/index.html#manual_non_exhaustive
2021-05-30 19:33:46 +02:00
fcf8f938d2
use panic::set_hook to exit
2021-05-28 07:40:56 -07:00
60aaa7ae31
use book_config.src for edit path
...
use book_config.src for edit path
use book_config.src for edit path
fmt
concat the path, this is a url
2021-05-27 21:54:58 -07:00
3c2b8cd10f
Merge pull request #1539 from joshrotenberg/report_config_errors
...
Report book.toml parse error when invalid fields are found
2021-05-24 13:25:07 -07:00
6b0b42ebcc
update build and rust config change
2021-05-24 12:01:56 -07:00
7a3513200f
Update src/config.rs
...
Co-authored-by: Eric Huss <eric@huss.org>
2021-05-24 11:59:32 -07:00
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
16c5ec4d74
Remove chapter_begin id from print output.
2021-05-22 15:12:54 -07:00
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
b364e8ea2c
Fix typos ( #1540 )
...
Signed-off-by: Andrea Gelmini <andrea.gelmini@gelma.net>
2021-05-21 12:56:32 +02:00
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
b21446898a
Add useful messages when command line preprocessor fails
2021-05-08 12:48:57 -04:00
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
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
c1d982d92b
Remove duplicate "name" attribute on input
2021-04-24 17:27:49 +02:00
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
bbf54d7459
[ReviewFix] Replace edit baseurl with template and make visibility independent of git_repository_url.
2021-04-19 16:16:08 +02:00
dcc642e66d
[ReviewFix] cargo fmt
2021-04-19 14:51:16 +02:00
2b738d4425
[ReviewFix] Fix variable naming
2021-04-19 14:51:16 +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
30ce7e79ac
Skip HTML comments in the summary
...
- Revert changes in parse_numbered(). They were unnecessary.
2021-04-05 18:31:11 +08: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
0eb23efd44
Make page-break not configurable
2021-03-16 09:33:19 +08:00
e78a8471c7
Add page-break option
2021-03-12 14:00:29 +08:00
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
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
45d41eac5f
Fix some issues with fragment scrolling and linking.
2021-02-12 16:37:07 -08:00
1a0c296532
Merge pull request #1426 from ehuss/search-mark-words
...
Fix search highlighting with multiple words.
2021-01-14 17:01:52 -08:00
9b4ab72a80
Merge pull request #1418 from ehuss/relative-renderer-command
...
Fix relative paths for renderer commands.
2021-01-14 17:01:41 -08:00
cdea0f6b61
Add missing parenthesis in doc comment.
2021-01-13 14:26:14 -08:00
e9b0be7090
Add intra-docs links to docs
...
Also fixes some punctuation and changes some wording.
2021-01-10 14:51:30 -08:00
d402a12e88
Skip HTML comments in the summary
2021-01-08 18:16:03 +08:00
77e7cfd22b
Change `init --theme` to place theme in root. ( #1432 )
2021-01-07 01:29:38 +01:00
09e7bb76dc
Remove mark from URL on escape. ( #1427 )
2021-01-05 19:31:16 +01:00
28387130c0
Fix search highlighting with multiple words.
2021-01-04 14:20:36 -08:00
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
beec17e55d
Add ability to generate shell completions via clap
2021-01-04 23:51:02 +02:00
e651f4d734
Merge pull request #1420 from apatniv/clippy_remove_clone
...
Clippy lint: Remove unnecessary clone
2021-01-04 11:33:37 -08:00
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
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
95e0743bc0
clippy: use char instead of str
2020-12-31 15:37:34 -05:00
3c97525743
Clippy lint: Remove unnecessary clone
2020-12-31 15:18:37 -05:00
9a65c8ab92
Fix relative paths for renderer commands.
2020-12-30 17:46:29 -08:00
fd4137a9ea
fix: readerer get theme dir path bug
2020-12-28 09:20:23 -08:00
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
cf2459f730
Merge pull request #1393 from apatniv/fixing_error
...
Missing chapters Error Reporting: Add file name
2020-12-14 08:33:36 -08:00
6bcabcbb6b
Improve error message
2020-12-14 16:11:01 +09:00
ef993e8cc2
Run rust formmater
2020-12-05 20:27:03 -05:00
a3a5386da0
Add more context regarding which missing file creation failed
2020-12-05 20:17:45 -05:00
942cc12a74
Add chapter name to search result breadcrumbs
2020-11-25 14:46:49 +11:00
552e3378cf
Merge pull request #1378 from daynin/serialize-build-section
...
allow to serialize the "build" section
2020-11-12 10:41:12 -08:00
7c0ddff96a
allow to serialize the "build" section
2020-11-12 19:32:32 +03:00
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
58f66a146d
Merge pull request #1375 from dtolnay/playground
...
Fix stray spacing after #playground code
2020-11-10 14:06:09 -08:00
643d5ecc5c
Merge pull request #1285 from FrankHB/patch-1
...
Handled UTF-8 BOM
2020-11-10 14:02:01 -08:00
c712ba7aab
Escape <> in rendered toc
2020-11-08 22:26:30 -08:00
1450070f73
Fix stray spacing after #playground code
2020-11-05 21:43:04 -08:00
9e9cf49c50
Added a test.
...
Signed-off-by: FrankHB <frankhb1989@gmail.com>
2020-10-07 22:50:25 +08:00
780fb979a0
Avoided the redundant allocation.
...
Signed-off-by: FrankHB <frankhb1989@gmail.com>
2020-09-29 18:01:06 +08: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
e6ac8ecdd9
Fix print icon.
2020-09-22 13:24:13 -07:00
e0b247e9d6
Add config option to disable print html, css, and icon
2020-09-22 11:40:02 -07:00
b349e8abc9
Fix windows typo
2020-09-09 17:57:45 +02:00
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
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
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
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
33ea661350
Merge pull request #1310 from dtolnay/nojekyll
...
End .nojekyll file with newline
2020-09-06 09:21:59 -07:00
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
fd59dc73e5
Adjust wording
2020-09-06 09:11:53 -07:00
5ea8e55aea
collect all test failures before failing
2020-09-03 18:36:51 -07:00
1acf23ff73
Support emitting CNAME file for publishing at a custom domain
2020-09-02 11:24:48 -07:00
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
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
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
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
9d5c454e47
delete '+' replacement and use cargo fmt to format
2020-08-08 15:13:22 +08:00
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
60be20a783
allow space in SUMMARY.md's link destination
2020-08-03 09:49:01 +08:00
8746206060
Merge pull request #1284 from ericonr/opt
...
Mention that uninstalled backend isn't marked optional.
2020-07-30 20:22:55 -07:00
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
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
65d9eb6f7e
Handled UTF-8 BOM
...
Fixed #1155 .
2020-07-25 13:02:44 +08:00
303db0ddec
Merge pull request #1277 from maniyar1/patch-1
...
Update highlight.js
2020-07-21 14:17:03 -07:00
60029e4e15
Add R-lang support
2020-07-20 19:03:29 -04:00
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
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
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
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
b0c6f2d7a3
Don't copy default favicon if at least one is overridden.
2020-06-27 16:30:46 -07:00
e9951af73e
Fix sidebar scrolling with part titles.
2020-06-24 21:13:02 -07:00
4699269e49
Add SVG favicon.
2020-06-23 10:58:10 -07:00
f59cfe7e2f
Fix dest-dir command-line flag.
2020-06-23 10:55:01 -07:00
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
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
9a97f0a096
Fix init creating empty `[rust]` table. ( #1233 )
2020-06-22 16:36:37 +02:00
bc23d08fa5
Rename playpen to playground. ( #1241 )
...
looks good
2020-06-22 16:34:25 +02:00
84d848f292
Fix issue where Font Awesome overrides `.hidden`'s `display: none`
2020-06-10 12:55:22 -05:00
d7df832cce
fix test and formatting
2020-06-10 15:33:09 +02:00
406b325c54
fix usage of newly stablized inner_deref/as_deref
2020-06-10 13:09:18 +02:00
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
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
cda28bb618
Generate 404.html page ( #539 )
2020-06-10 12:46:23 +02:00
23f5ffd6d6
Change default preferred-dark-theme to `navy`.
2020-06-08 11:40:38 -07:00
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
da55cf273f
Changed redirect mapping to HashMap<String, String> and improved error handling
2020-05-27 03:12:57 +08:00
b2d50392ea
Emit redirects towards the end of the rendering process
2020-05-27 02:42:56 +08:00
a5086a1e58
Added a redirect map to the HTML config
2020-05-27 02:38:04 +08:00
6c4c3448e3
Update dependencies. ( #1211 )
...
* Removed the itertools dependency
* Removed an unused feature flag
* Stubbed out a toml_query replacement
* Update dependencies.
* Bump env_logger.
* Use warp instead of iron for http server.
Iron does not appear to be maintained anymore. warp/hyper seems to be
reasonably maintained. Unfortunately this takes a few seconds more
to compile, but shouldn't be too bad.
One benefit is that there is no longer a need for a separate websocket
port, which makes it easier to run multiple servers at once.
* Update pulldown-cmark to 0.7
* Switch from error-chain to anyhow.
* Bump MSRV to 1.39.
* Update elasticlunr-rs.
Co-authored-by: Michael Bryan <michaelfbryan@gmail.com>
2020-05-20 23:32:00 +02:00
5d5c55e619
Merge pull request #1171 from mark-i-m/master
...
implement support for book parts
2020-05-20 12:17:45 -07:00
e677b72eb8
Merge pull request #1188 from pheki/remove-google-surveillance
...
Remove google fonts by serving them locally
2020-05-20 11:01:07 -07:00
7e090ca42f
Also copy font licenses when copy-fonts is enabled
2020-05-19 03:17:01 -03:00
122c988477
Rename config from no-copy-fonts to copy-fonts
2020-05-19 03:09:25 -03:00
d0fe9bd41c
make part titles another SummaryItem
2020-05-18 11:18:14 -05:00
91e3aa4b55
try to satisfy msrv?
2020-05-17 16:53:06 -05:00
2d63286c63
make part titles bold
2020-05-17 16:53:06 -05:00
5dd2a5bff4
implement support for book parts
2020-05-17 16:53:06 -05:00
1b3b10d2ae
Do not allow the sidebar to be dragged outside the window. ( #1229 )
2020-05-17 22:05:12 +02:00
2c26c65f4d
Remove google fonts by serving them locally
...
Co-authored-by: Aral Balkan <aral@ind.ie>
Co-authored-by: Collyn O'Kane <47607823+okaneco@users.noreply.github.com>
2020-05-15 02:48:28 -03:00
6038af292f
Remove some unnecessary blocks.
2020-05-10 09:23:40 -07:00
43008ef2ef
fix issues from code review
2020-05-10 09:04:02 -07:00
d605938886
Bring back draft chapters
2020-05-10 09:04:02 -07:00
c2d58158da
Revert HTML auto-formatting
2020-05-10 08:42:53 -07:00
61c8413138
Allow to define own HTML <head> attributes
...
Create a `index.hbs` template file to render additional HTML <head> attributes
2020-05-10 08:42:53 -07:00
8ee950e3de
Merge pull request #1214 from ehuss/fix-clippy
...
Fix some clippy warnings.
2020-05-10 08:39:19 -07:00
c44ef1b2f0
Fix some clippy warnings.
2020-05-10 08:29:50 -07:00
07dfc4b89a
Merge pull request #1207 from toyboot4e/fix-mdbook_book
...
Enable `MDBOOK_BOOK` to overwrite `book.toml`
2020-05-08 06:51:21 -07:00
282e55122e
Update src/config.rs
...
Co-authored-by: Eric Huss <eric@huss.org>
2020-05-08 19:56:41 +09:00
b1cf3f117d
Links preprocessor: support pluses in file paths
2020-05-03 14:50:03 +02:00
d665732056
Links preprocessor: test links with special characters
2020-05-03 14:42:22 +02:00
2f59dbf1ef
Fix example of MDBOOK_BOOK (again)
2020-05-03 18:58:41 +09:00
3a63276727
Not to use `matches!`
2020-05-03 18:16:44 +09:00
4c64f23089
Fix example of MDBOOK_BOOK
2020-05-03 17:54:35 +09:00
683d2b2240
Fix use of MDBOOK_BOOK
2020-05-03 17:54:17 +09:00
2732c5e8f7
Update docs and tweak error messages.
2020-04-21 15:34:59 -07:00
6b550cb4bb
Make missing backends optional.
2020-04-21 15:13:14 -07:00
28ce8f5ac0
Some edition cleanup and fixes.
2020-04-21 12:26:48 -07:00
255756cfee
Make new [rust] config and move edition config under it
2020-04-21 10:24:47 -07:00
53d821bf6d
Add edition to hbs renderer
2020-04-21 10:24:47 -07:00
d39d4517aa
Add support for Rust edition
2020-04-21 10:24:47 -07:00
josh rotenberg
Eric Huss
Riccardo Magliocchetti
josh rotenberg
Eldred Habert
Andrea Gelmini
apatniv
Flavio Castelli
Guillaume Gomez
Jonas Berlin
Tatsuya Kawano
David Tolnay
Evian-Zhang
Tim Small
pierwill
Alexandru Macovei
Pietro Albini
francis-du
Kousuke Takaki
avitex
Sergey Golovin
FrankHB
Camelid
Ross MacArthur
ifeanyi
Gus Wynn
Søren Mortensen
Camelid
Érico Rolim
maniyar1
Owen Nelson
ThePuzzlemaker
Manuel Woelker
Bryce Fisher-Fleig
Michael-F-Bryan
Aphek
mark
Mathieu David
Gilles Rasigade
toyboot4e
Tomasz Kurcz
Kim Hermansson
kngwyu
Gabriel Majeri