9b4ab72a80
Merge pull request #1418 from ehuss/relative-renderer-command
...
Fix relative paths for renderer commands.
2021-01-14 17:01:41 -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
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
95e0743bc0
clippy: use char instead of str
2020-12-31 15:37:34 -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
942cc12a74
Add chapter name to search result breadcrumbs
2020-11-25 14:46:49 +11:00
c712ba7aab
Escape <> in rendered toc
2020-11-08 22:26:30 -08: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
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
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
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
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
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
bc23d08fa5
Rename playpen to playground. ( #1241 )
...
looks good
2020-06-22 16:34:25 +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
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
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
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
5dd2a5bff4
implement support for book parts
2020-05-17 16:53:06 -05: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
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
c44ef1b2f0
Fix some clippy warnings.
2020-05-10 08:29:50 -07: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
1d265fd143
Broaden scope of suppressed warnings for listings without a main fn
...
At present, code listings without a main function will be wrapped in one and
annotated with an allow lint check attribute provided by the following [code][]:
```
format!(
"\n# #![allow(unused_variables)]\n{}#fn main() {{\n{}#}}",
attrs, code
)
```
A broader lint check attribute such as `#![allow(unused)]` seems like it might
better fit the apparent intent of this code.
Addresses: https://github.com/rust-lang/mdBook/issues/1192
[code]: 769cc0a7c1/src/renderer/html_handlebars/hbs_renderer.rs (L635-L638)
2020-04-18 01:36:11 -04:00
e839ef0866
Fix sidebar line-height. ( #1182 )
2020-04-03 21:09:23 +02:00
bd14d0910a
Avoid a possible recursive copy when destination (build_dir) is underneath source directory. Update docs to match.
2020-04-03 10:39:15 -07:00
59568208ff
Revert "Support anchors in SUMMARY ( #1173 )" ( #1175 )
...
This reverts commit 2baed040c2
2020-03-24 23:52:24 +01:00
2baed040c2
Support anchors in SUMMARY ( #1173 )
...
* Parse anchors in `SUMMARY.md`
* Support sub-links in SUMMARY with html renderer
* Add some tests for anchors
2020-03-24 19:15:28 +01:00
44c3213f5d
Merge pull request #1130 from sunng87/feature/handlebars-3.0
...
Update handlebars to 3.0
2020-03-08 18:54:39 -07:00
95fba3f357
Add a case for an empty `book_title` parameter
...
Html page title for every chapter in the book is created by the following code:
```rust
let title: String;
{
let book_title = ctx
.data
.get("book_title")
.and_then(serde_json::Value::as_str)
.unwrap_or("");
title = ch.name.clone() + " - " + book_title;
}
```
If the `book.toml` file is missing, and `book_title` parameter is empty, there's an awkward ` - ` string hanging at the end of each chapter's title.
This PR adds a `match` case to handle that kind of situation.
2020-02-15 23:13:37 +01:00
1947f8ca65
Update handlebars to 3.0
2020-01-24 11:01:44 +08:00
2a3088422a
Upgrade pulldown_cmark to 0.6.1
2019-11-11 20:25:38 +01:00
1f505c2b2e
Revert "Add support for Rust edition 2018 in playpens ( #1086 )" ( #1093 )
...
This reverts commit a7b3aa0444
2019-11-11 13:24:13 +01:00
a7b3aa0444
Add support for Rust edition 2018 in playpens ( #1086 )
...
* Add support for Rust edition 2018 in playpens
* Add Rust edition support to rustdoc
* Run rustfmt
* Fix enum variant reference
2019-11-11 12:42:24 +01:00
a9160acd64
Merge pull request #1088 from benediktwerner/master
...
Fix hiding of empty boring lines
2019-11-07 07:44:47 -08:00
4c1bca1684
Don't hide macro lines
2019-11-07 02:42:02 +01:00
8fffb2a704
Hide lines in ignored code blocks
2019-11-07 02:20:10 +01:00
3ea0f9b745
Lowercase matching the theme name ( #1079 )
...
* Using .to_lowercase() on the theme matching to avoid needed exact capitolization in the book.toml
* Changed the default-dark-theme from .to_string() to .to_lowercase() to match theme
2019-11-05 13:55:08 +01:00
f5549f2267
Hide empty lines starting with '#' in playpens
2019-11-04 14:03:25 +01:00
f79d5d4582
rust-lang-nursery -> rust-lang
...
Fixes #1080
2019-10-29 08:04:16 -05:00
21d8f394ae
Fix "next chapter" spacer handling. ( #1075 )
2019-10-25 17:33:21 +02:00
6af6219e5b
[Feature] expandable sidebar sections (ToC collapse) ( #1027 )
...
* render(toc): render expandable toc toggle
* ui(toc): js/css logic to toggle toc
* test: update rendered output css selector
* config: add `html.fold.[enable|level]`
* renderer: fold according to configs
* doc: add `output.html.fold`
* refactor: tidy fold config
- Derive default for `Fold`.
- Use `is_empty` instead of checking the length of chapters.
2019-10-19 09:56:08 +02:00
e5f74b6c86
Option to display copy buttons. ( #1050 )
...
* Option to display copy buttons.
- Added field to playpen data structure
- Communicate through window.playpen_copyable
- Javascript updated to check before displaying copy buttons.
* html -> html_config
Also:
- update description of copyable in source code.
- update description of line_numbers (my last PR to this repository)
2019-10-17 12:44:54 +02:00
84a2ab0dba
Reapply: Move hiding of boring lines into static content ( #846 ) ( #1065 )
...
* Move hiding of boring lines into static content (#846 )
* Fix test for hidden code
2019-10-16 11:27:14 +02:00
2b3304cb8b
Revert "Move hiding of boring lines into static content ( #846 )" ( #1064 )
...
This reverts commit 4448f3fc4b
2019-10-10 14:31:55 +02:00
4448f3fc4b
Move hiding of boring lines into static content ( #846 )
2019-10-10 13:55:29 +02:00
4a93eddae2
Fix "next" navigation on index.html (take 2). ( #1005 )
2019-10-06 17:55:36 +02:00
93c9ae5700
Merge pull request #1037 from Flying-Toast/prefers-color-scheme
...
Automatically use a dark theme according to 'prefers-color-scheme'
2019-10-05 11:33:52 -07:00
9bdec5e7cc
preferred-dark-theme defaults to default-theme
2019-10-04 19:32:03 -04:00
a058da8b74
Fix merge conflict.
2019-09-26 11:03:51 -07:00
73be1292ab
Merge pull request #1035 from andymac-2/line-numbers
...
Added line numbers to editable sections of code.
2019-09-26 10:53:32 -07:00
b0ae14a2c7
Automatically use a dark theme according to 'prefers-color-scheme'
2019-09-25 19:11:28 -04:00
81ab2eb7db
Added line numbers to editable sections of code.
...
- Added line numbers to config struct
- Added playpen_line_numbers field to hbs renderer.
- Added section to set `window.playpen_line_numbers = true` in page template
- Use line number global variable to show line numbers when required.
2019-09-24 21:27:02 +08:00
213171591a
De-duplicate calling Config::html_config()
2019-09-22 21:48:49 +02:00
a873d46871
Implement a markdown renderer ( #1018 )
...
Use case: when trying to `mdbook test` a file that has many `include`
directives, and a test fails, the line numbers in the `rustdoc` output
don't match the line numbers in the original markdown file.
Turning on the markdown renderer implemented here lets you see what is
being passed to `rustdoc` by saving the markdown after the preprocessors
have run.
This renderer could be helpful for debugging many preprocessors, but
it's probably not useful in the general case, so it's turned off by
default.
2019-08-30 12:20:53 +02:00
bb412edf53
Made sure the tests pass
2019-07-21 04:32:28 +08:00
e56c41a1c2
The HTML renderer now cleans its own build directory
2019-07-21 02:37:09 +08:00
b91e5c8807
Merge pull request #977 from sunng87/feature/handlebars-2.0
...
(feat) update handlebars to 2.0
2019-07-12 09:56:51 -07:00
2d11eb05fe
(feat) update handlebars to 2.0
2019-07-13 00:11:05 +08:00
228e99ba11
Fix even more print page links. ( #963 )
2019-07-01 17:52:25 +02:00
bb3398bdbb
Merge pull request #941 from rnitta/configurable-language
...
Change language attribute of the book to configurable
2019-06-24 08:56:22 -07:00
2497e77bf1
Support strikethrough and tasklists. ( #952 )
2019-06-12 17:02:03 +02:00
3cfed10098
Update to pulldown-cmark 0.5. ( #898 )
...
* Update to pulldown-cmark 0.4.1.
* Update to pulldown-cmark 0.5.2.
* Remove pulldown-cmark-to-cmark dependency.
Since it is not compatible with the new pulldown-cmark. This example isn't
directly usable, anyways, and I think the no-op example sufficiently shows how
to make a preprocessor.
* cargo fmt
* Fix example link.
2019-06-11 18:26:24 +02:00
a655d5d241
Header elements wrap links ( #948 )
...
* swap hierarchy of header for that of link
* fix comment
2019-06-03 14:31:15 +02:00
53ba0d6655
Remove 'static lifetime from static vars ( #947 )
2019-05-31 18:01:02 +02:00
4f7c299de7
update language attribute to configurable
2019-05-30 11:53:49 +09:00
8542f7f29d
Transition to 2018 edition ( #933 )
...
* Transition to 2018 edition
* Update Travis CI badge in README
* Remove non-idiomatic `extern crate` lines
2019-05-25 20:50:41 +02:00
df12cc55c8
Revert "Merge pull request #889 from s3bk/master" ( #917 )
...
* Revert "Merge pull request #889 from s3bk/master"
This reverts commit b30b58b565c6220fba83
2019-05-09 20:18:28 +02:00
8bb5426441
Fix keyboard chapter navigation for `file` urls. ( #915 )
2019-05-08 00:29:46 +02:00
a674c9eff1
Fix "next" navigation on index.html. ( #916 )
2019-05-08 00:27:48 +02:00
581187098c
Deny 2018 edition idioms globally ( #911 )
2019-05-06 22:50:34 +02:00
ab7802a9a9
Fix most of clippy warnings ( #914 )
...
* Fix clippy: cast_lossless
* Fix clippy: match_ref_pats
* Fix clippy: extra_unused_lifetimes
* Fix clippy: needless_lifetimes
* Fix clippy: new_without_default
* Fix clippy: or_fun_call
* Fix clippy: should_implement_trait
* Fix clippy: redundant_closure
* Fix clippy: const_static_lifetime
* Fix clippy: redundant_pattern_matching
* Fix clippy: unused_io_amount
* Fix clippy: string_lit_as_bytes
* Fix clippy: needless_update
* Fix clippy: blacklisted_name
* Fix clippy: collapsible_if
* Fix clippy: match_wild_err_arm
* Fix clippy: single_match
* Fix clippy: useless_vec
* Fix clippy: single_char_pattern
* Fix clippy: float_cmp
* Fix clippy: approx_constant
2019-05-06 20:20:58 +02:00
0aa3a9045a
cargo fmt
2019-05-05 22:00:24 +07:00
b30b58b565
Merge pull request #889 from s3bk/master
...
new "Book" theme
2019-05-04 17:45:37 +02:00
9712347b9c
Merge pull request #796 from badboy/dont-trim-external-js-path
...
Don't strip relative path of additional javascript files
2019-04-26 09:01:39 +02:00
Eric Huss
pierwill
apatniv
francis-du
avitex
David Tolnay
Ross MacArthur
Søren Mortensen
Érico Rolim
Manuel Woelker
Michael-F-Bryan
Aphek
mark
Mathieu David
Gilles Rasigade
Kim Hermansson
kngwyu
Gabriel Majeri
Mike English
Andrew Mackenzie
Dylan DPC
Martin Carton
Tomasz Różański
Ning Sun
Marcus Klaas de Vries
Benedikt Werner
Ricky
Steve Klabnik
Weihang Lo
Andrew Pritchard
Adrian Heine né Lang
Flying-Toast
Tjeu Kayim
Carol (Nichols || Goulding)
rnitta
lzutao
Allen