Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2024-12-14 23:02:34 +00:00
Code Issues Projects Releases Packages Wiki Activity
2259 commits 9 branches 95 tags 23 MiB
Commit graph

1185 commits

Author SHA1 Message Date
ImUrX
ecdb411711 fix mistakes 2023-05-28 10:47:14 -07:00
ImUrX
a4e206168d Add working heading extension 2023-05-28 10:47:13 -07:00
Eric Huss
d8f171a996 Apply clippy::manual_while_let_some 2023-05-13 09:50:32 -07:00
Eric Huss
0ef3bb1cc6 Apply clippy::needless_borrowed_reference 2023-05-13 09:46:30 -07:00
Eric Huss
54df8234ed Apply clippy::let_unit_value 2023-05-13 09:45:46 -07:00
Eric Huss
dc08e37320 Apply clippy::borrow_deref_ref 2023-05-13 09:44:50 -07:00
Eric Huss
45a8575b95 Apply clippy::needless_borrow 2023-05-13 09:44:11 -07:00
Eric Huss
f4507aeb9b
Merge pull request #2080 from t2y/fix-copy-fonts-message 
Fix handling of copy-fonts=true when fonts.css is overridden
 2023-05-13 09:19:06 -07:00
Eric Huss
01047846a9 Don't copy the stock fonts if the user has overridden fonts.css. 
This wasn't behaving as I was really intending.
 2023-05-13 09:05:25 -07:00
Eric Huss
75a6d65e5a Don't warn on copy-fonts=true (the default) when fonts.css is overridden. 2023-05-13 08:51:04 -07:00
Eric Huss
af036d9f45
Merge pull request #2057 from seanpoulter/init-skip 
fix(cli): init --force skips confirmation prompts
 2023-04-30 14:18:30 -07:00
Tetsuya Morimoto
04016f3be6 Refactor the warning message related to copy_fonts so that a user simply configures it 2023-04-28 12:46:49 +09:00
Eric Huss
35fdd00203 Switch from gitignore to ignore 2023-04-22 12:53:54 -07:00
Sean Poulter
bffdb0b03d fix(cli): init --force skips confirmation prompts 2023-04-03 03:05:24 -04:00
Andreas Deininger
a2c88ae0f1 Convert links from http to https protocol 2023-04-02 21:35:08 +02:00
Eric Huss
4c59405e5c
Merge pull request #1986 from mgeisler/preprocessors-for-test 
Run preprocessors in `mdbook test`
 2023-03-04 14:55:10 -08:00
Eric Huss
703a215ef8
Merge pull request #2039 from Skwodo/master 
Change overflow-x hidden to clip
 2023-03-04 14:05:01 -08:00
Skwodo
f5f96bc4f4 change overflow-x hidden to clip 2023-03-02 21:01:38 +01:00
Eric Huss
c15220d1a1
Merge pull request #2017 from thanatos/roy/fix-sidebar 
Default the sidebar to visible in large screens
 2023-02-13 12:42:15 -08:00
Eric Huss
1517435441
Merge pull request #2021 from rust-lang/revert-2009-deps/toml 
Revert "bump 'toml' dependency"
 2023-02-13 07:44:45 -08:00
Eric Huss
90fbe112af
Revert "bump 'toml' dependency" 2023-02-13 07:31:33 -08:00
Martin Geisler
c150529c7c
Remove spammy debug! log from path_to_root 
The log statement is empty and simply fills up the logs when you run `mdbook` with `RUST_LOG=debug`.
 2023-02-13 16:17:31 +01:00
Roy Wellington Ⅳ
fa6aa2ced8 Default the sidebar to visible in large screens 
The code here leads me to believe that the intention is for the sidebar
to be default visible on large screens (where `clientWidth` > 1080) and
hidden otherwise.

However, as previously written, if the `localStorage.getItem` call fails
(for example, if the user agent is not accepting cookies), then we fall
back to `sidebar = sidebar || 'visible';` — but `sidebar` is already set
to `hidden`, so the `|| 'visible'` never happens.

This results in the sidebar hiding itself on every navigation through an
mdBook, meaning if you're just switching between sections trying to find
something that you keep needing to re-open the sidebar.
 2023-02-11 18:04:58 -05:00
Eric Huss
2c710d3b7d
Merge pull request #1987 from ehuss/theme-fonts 
Make fonts part of the theme.
 2023-02-08 15:56:40 -08:00
Eric Huss
e352e4f59c
Merge pull request #1994 from Skwodo/master 
fix overflow-x on mobile
 2023-02-08 15:37:53 -08:00
Eric Huss
734936d819 Add some comments about overflow-x 2023-02-08 15:25:14 -08:00
Daniel Eades
2160613c6a bump 'toml' dependency 2023-02-08 15:40:15 +00:00
Skwodo
ca46086e79 fix overflow-x on mobile 2023-01-21 22:41:01 +01:00
Noritada Kobayashi
dcc9efea0a Remove the WebKit-specific scrollbar styling altogether 
It is preferable to remove WebKit-specific styling and use the browser
and OS default scrollbars.
Thanks to comments from @julianfortune, @arniu, and @ehuss.

Closes #1483.
 2023-01-18 23:51:09 +09:00
Eric Huss
c2d973997a Make fonts part of the theme. 2023-01-15 11:42:46 -08:00
Martin Geisler
b09aa0e65c Run preprocessors in mdbook test 
While adding support for translations[1] to Comprehensive Rust 🦀, I
noticed that `mdbook test` doesn’t execute preprocessors the same way
as `mdbook build`.

This PR makes the two commands use the same code to find and execute
preprocessors.

[1]: https://github.com/google/comprehensive-rust/pull/130
 2023-01-15 11:44:46 +01:00
Noritada Kobayashi
1ba2c063e0 Thin scrollbars in Chrome and Safari to make them less assertive (#1483) 2022-12-22 15:40:03 +09:00
Eric Huss
fcf0cebf6c Fix test with multiple library paths 2022-12-17 07:11:13 -08:00
David
87a381e0a7 upgrade clap to 4.0 2022-12-14 17:11:08 -08:00
Eric Huss
21ab85cd03 Update notify 
Update notify from 4.0.17 to 5.0.0
https://github.com/notify-rs/notify/blob/main/UPGRADING_V4_TO_V5.md
https://github.com/notify-rs/notify/blob/main/CHANGELOG.md#notify-500-2022-08-28
 2022-12-14 14:01:27 -08:00
armandocumate
cf1557e454 update for hidden only on clipboard 2022-12-14 06:54:45 -08:00
LePichu
e3c484af01 fix: random ref in 2022-12-06 12:05:11 +05:30
Eric Huss
8a02fc755f Fix broken doc link 2022-11-28 09:53:47 -08:00
Eric Huss
f32bd6f945 Show the currently selected theme. 2022-11-21 15:27:39 -08:00
Eric Huss
f64fcbc07d Fix clipping in theme popup 2022-11-21 14:00:18 -08:00
Eric Huss
d45f02d38c
Merge pull request #1924 from averms-forks/html-conformance 
Better HTML5 conformance
 2022-11-13 13:29:18 -08:00
Eric Huss
666975a1ef
Merge pull request #1884 from willcrichton/master 
Add support for watching additional directories
 2022-11-13 12:53:19 -08:00
Will Crichton
8b486dfc71 Fix compilation failure 2022-11-12 14:23:05 -08:00
Aman Verma
db092a404e State canonical URL using <link> not <meta>. 
The Google SEO docs describe using the link element to specify the canonical
page in a redirect. They don't mention anything about <meta>.
 2022-11-12 14:54:28 -06:00
Aman Verma
edda3d1b51 Fix formatting of content attr in <meta http-equiv=refresh> 
According to the HTML specification[1], there needs to be a space after the
semicolon and the URL must be unquoted.

[1]: https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv-refresh
 2022-11-12 14:47:21 -06:00
Aman Verma
27a11e7b35 Don't generate obsolete charset attrs in <script>. 
According to the HTML specification[1], the charset attribute is obsolete in
script elements.

[1]: https://html.spec.whatwg.org/multipage/obsolete.html#HTMLScriptElement-partial
 2022-11-12 14:45:09 -06:00
Aman Verma
cfd4c93d88 Don't generate redundant <meta http-equiv=content-type>. 
Quoting from the HTML specification[1]:

  A document must not contain both a meta element with an http-equiv attribute
  in the Encoding declaration state and a meta element with the charset
  attribute present.

So we remove the <meta> with the http-equiv attribute from our template.

[1]: https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv-content-type
 2022-11-12 14:27:52 -06:00
Will Crichton
852a882fab Improve error handling of extra-watch-dirs watching, fix not watching whitelisted files outside book root 2022-11-07 12:20:59 -08:00
Will Crichton
fb0cbc90e3 Add support for watching additional directories 2022-10-28 11:47:33 -07:00
armandocumate
3fc036e01a fi xcopying invisible text 2022-10-14 16:53:59 -07:00
Brett Chalupa
79c159d123 Add styles for <kbd> elements 
Allows for special styles to call them out since they're different than
normal text and different than code. They can make use of styles they
inherit for font style and weight.

Notes on changes:

- Added new CSS variables for reused elements
- The font-* rules are separate for each aspect so that they can inherit
  bold/italic/etc

Closes https://github.com/rust-lang/mdBook/issues/1813
 2022-10-06 16:02:29 -04:00
Kian-Meng Ang
cb01f11ad1 Fix typos 
Found via `codespell -S ./src/theme -L crate,nam,varius,phasis`
 2022-09-29 22:41:12 +08:00
David
75857fbf73
feat: use once_cell instead of lazy_static (#1894) 2022-09-22 15:05:39 -07:00
Martin Geisler
3958260353 Simplify the use of Option::and_then 
I found a few places where `Option::and_then` could be simplified (in
my opinion) with `?` or with `match`.
 2022-09-11 00:46:26 +02:00
Dylan DPC
66bf85b14f Require Rust 2021 edition 
This allows us to clean up and simplify the code.
 2022-09-09 16:00:35 +02:00
Guillaume Gomez
76b0493fb0 Remove unneeded type attribute for <script> 2022-08-29 21:07:50 +02:00
Chris Lovett
74eb4059d6
add a --chapter option to mdbook test. (#1741) 
Sometimes when working on large books it is handy to be able to run mdbook on a single chapter of a book.
 2022-08-25 19:13:51 -07:00
Eric Huss
fff067b2a8
Merge pull request #1836 from mgeisler/trim-trailing-whitespace 
Avoid empty last line in editable code blocks
 2022-08-10 19:55:06 -07:00
Martin Geisler
217546c2a0 Trim trailing whitespace in Rust code blocks 
Before, a code block would always end with a final newline. The
newline was added unconditionally by `hide_lines`.

When the code block is syntax highlighted by highlight.js, this is not
a problem, no empty line is added for a final trailing `\n` character.
However, when the code block is editable and thus handled by the ACE
editor, a trailing newline _is_ significant. I believe this issue is
most closely described by https://github.com/ajaxorg/ace/issues/2083
in the upstream repository.

The effect of the way ACE handles newlines is that a code block like

    <pre>
      Some code
    </pre>

will create an editor with _two_ lines, not just one.

By trimming trailing whitespace, we ensure that we don’t accidentally
create more lines in the ACE editor than necessary.
 2022-08-10 03:11:08 +02:00
mitchmindtree
13035baeae Workaround rust nightly borrowcheck error (#1860) 
Surprisingly, this fixes the error filed at #1860!

This seems suspicious, perhaps indicative of a bug in Rust's non-lexical
lifetime handling?

The lifetimes in the `handlebars::Renderable::render` method signature
are quite complicated, and its unclear to me whether or not Rust is
catching some new safety edge-case that wasn't previously handled
correctly...

Possibly related to `drop` order, which I *think* is related to the
order of binding statements?
 2022-07-22 15:15:12 +10:00
Steven Engler
6a4ba95926 Fixed code padding in headings 2022-07-13 19:12:33 -04:00
Joseph Priou
f92911b8aa
Revert "remove __non_exhaustive members, add non_exhaustive attribute instead" 2022-07-09 17:43:17 +02:00
Fauconfan
11781f0c1b remove __non_exhaustive members, add non_exhaustive attribute instead 2022-07-09 15:05:06 +02:00
Eric Huss
1d2b720ebe Always show the "serving on" info for mdbook serve. 2022-07-01 14:36:18 -07:00
ISSOtm
42129c6181 Always open index page with serve --open 2022-07-01 09:01:25 +02:00
ISSOtm
fa5f32c7fd Make link to first chapter active in index page 
Makes both pages more consistent, and also the previous test pass

Co-authored-by: Eric Huss <eric@huss.org>
 2022-06-29 23:51:18 +02:00
ISSOtm
8571883923 Mark the first chapter as "index", even if not the first book item 2022-06-29 08:35:41 +02:00
Eric Huss
4cf005d4bd
Merge pull request #1832 from ISSOtm/clippy 
Fix Clippy lints
 2022-06-27 14:28:39 -07:00
Eric Huss
b38792c166
Merge pull request #1833 from mattheww/2022-06_searchindex 
Omit words longer than 80 characters from the search index
 2022-06-27 14:17:40 -07:00
ISSOtm
248863addf Fix Clippy lints 
Also remove `allow(clippy::*)`s where possible
 2022-06-27 23:08:45 +02:00
Eric Huss
cbf0ca027d
Merge pull request #1806 from ehuss/button-overlap 
Make code buttons appear on hover (or tap on mobile)
 2022-06-27 13:58:17 -07:00
Eric Huss
5f00625c14
Merge pull request #1617 from lf-/x-overflow 
Fix some x overflows
 2022-06-27 11:01:48 -07:00
Matthew Woodcraft
1f8c090a5f When creating the search index, omit words longer than 80 characters 
This avoids creating deeply nested objects in searchindex.json
 2022-06-26 12:22:52 +01:00
Dylan DPC
a5f861bf2b
Revert "Omit words longer than 80 characters from the search index" 2022-06-22 13:31:16 +02:00
Eric Huss
2b903ad057 Make code block icons appear on hover. 2022-06-01 18:48:34 -07:00
Matthew Woodcraft
d65ce55453 When creating the search index, omit words longer than 80 characters 
This avoids creating deeply nested objects in searchindex.json
 2022-05-22 14:00:20 +01:00
Eric Huss
37d756ae75 Adjust overlap of code buttons with code blocks. 2022-05-16 19:27:46 -07:00
Eric Huss
f8782666ba
Merge pull request #1714 from joshrotenberg/draft-no-index 
Check for the index.html file before trying to opener::open it
 2022-05-16 08:04:38 -07:00
josh rotenberg
c74c682939 call find_chapter when opening browser 2022-05-11 13:14:38 -07:00
josh rotenberg
8b49600673 call first_chapter 2022-05-10 11:19:23 -07:00
josh rotenberg
29c729fd23 call first_chapter 2022-05-10 11:17:20 -07:00
josh rotenberg
5d65967448 add first_chapter function 2022-05-10 11:16:22 -07:00
klensy
af6237015a init regexes via lazy_static, don't recompute it 2022-05-06 10:05:52 +03:00
klensy
f3332fb0da Use serde's derive feature instead of directly importing serde_derive 2022-05-05 09:33:51 +03:00
Clark
a60571321a bail! in render() if specified theme directory does not exist 2022-04-26 20:20:44 +08:00
Eric Huss
ceff050bb4 Don't try to render summary links as markdown. 2022-04-14 20:35:39 -07:00
josh rotenberg
860a17d85a
Merge branch 'rust-lang:master' into draft-no-index 2022-04-04 18:59:39 -07:00
Eric Huss
78bcda02cb Fix html print config default. 2022-03-30 07:58:27 -07:00
Eric Huss
a5fddfa468
Merge pull request #1749 from tommilligan/unique-search-anchors 
search: fix anchor ids for duplicate headers
 2022-03-28 12:44:20 -07:00
Eric Huss
7c37dd5e85
Merge pull request #1731 from epage/clap3 
Port mdBook to clap3
 2022-03-28 12:34:17 -07:00
Ed Page
857ca19fe4 refactor: Move from deprecated arg_from_usage 2022-03-28 13:06:50 -05:00
Ed Page
a19d91ef37 refactor: Move from deprecated multiple 2022-03-28 13:06:50 -05:00
Ed Page
ac8526688a refactor: Move from deprecated empty_values 2022-03-28 13:06:50 -05:00
Ed Page
1e1c99bbdb refactor: Move from deprecated GlobalVersion 2022-03-28 13:06:50 -05:00
Ed Page
0c89293029 refactor: Move from deprecated ColoredHelp 2022-03-28 13:06:50 -05:00
Ed Page
39eb78c88b refactor: Move from deprecated SubCommand 2022-03-28 13:06:50 -05:00
Ed Page
372842aac6 refactor: Move from deprecated Arg::with_name 2022-03-28 13:06:50 -05:00
Ed Page
7934e06668 chore: Upgrade to clap3 2022-03-28 13:06:50 -05:00
Eric Huss
675c8c3f4e Add book title to 404 page title. 2022-03-27 17:17:20 -07:00
rsapkf
97cb77bbdd Add proper title to 404 page 2022-03-27 17:01:11 -07:00