jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2749 commits 2 branches 0 tags 9.1 MiB
Commit graph

1348 commits

Author SHA1 Message Date
Paolo Barbolini
623fc606a4 Replace once_cell::sync::Lazy with std::sync::LazyLock 2025-05-11 11:46:12 +02:00
Michael Howell
649a021647 sidebar: use the same resize grip as rustdoc and playground 2025-05-09 14:15:53 -07:00
Eric Huss
3c10b00096 Skip serializing of the multilingual field 
This skips serializing of the multilingual field since it is unused, and
we plan to remove it in the future. This helps avoid it showing up in
`mdbook init`.
 2025-05-05 14:05:00 -07:00
Eric Huss
c9ddb4dd98 Revert: Remove the book.multilingual field 
This reverts https://github.com/rust-lang/mdBook/pull/2646/ because I
overlooked that this is a public field in a public struct, which would
be a breaking API change.
 2025-05-05 14:01:49 -07:00
Eric Huss
17b197620b
Merge pull request #2679 from lolbinarycat/sidebar-size-2678 
fix(css): sidebar can no longer be larger than 80% of viewport width
 2025-05-03 16:33:32 +00:00
Krishan Mistry
7e9be8dee3 Warn on duplicate footnote definition and ignore subsequent definitions 2025-04-30 06:39:48 -07:00
binarycat
a54ee0215e fix(css): sidebar can no longer be larger than 80% of viewport width 2025-04-25 14:29:58 -05:00
Michael Howell
36fa0064de Break off query string when comparing url for sidebar 2025-04-21 12:03:17 -07:00
Eric Huss
46963ebf65 Fix some missing docs 
This removes the `allow(missing_docs)` and fixes any issues.

There's probably more work to be done to improve the API docs. This was
just a minor thing I wanted to clean up.
 2025-04-20 19:42:45 -07:00
Eric Huss
b0ef5a54cc Fix clippy::redundant_slicing 2025-04-20 19:25:50 -07:00
Eric Huss
fbc875dd9f Fix clippy::only-used-in-recursion 2025-04-20 19:25:50 -07:00
Eric Huss
e6b1413d22 Fix clippy::default_constructed_unit_structs 2025-04-20 19:25:50 -07:00
Eric Huss
8181445d99 Add a restricted set of clippy lints, required to pass 
This sets up CI to check clippy with a restricted set of clippy groups.
Some of the default groups have some excessive sets of lints that are
either wrong or style choices that I would prefer to not mess over at
this time. The lint groups can be adjusted later if it looks like
something that would be helpful.
 2025-04-20 19:25:46 -07:00
Eric Huss
14aeb0cb83
Merge pull request #2633 from GuillaumeGomez/speed-up-loading 
Speed up search index loading
 2025-04-21 00:10:57 +00:00
Eric Huss
3e6b42cfba
Merge pull request #2568 from szabgab/remove-needless-late-init 
[refactor] eliminate needless_late_init
 2025-04-19 13:12:39 +00:00
Eric Huss
06e8f6f849 Fix wrong quotes for eslint 2025-04-17 09:24:45 -07:00
Eric Huss
e5d5f5d02b Ignore SVG text elements in search highlighting 2025-04-17 07:39:22 -07:00
Eric Huss
98088c91dd
Merge pull request #2659 from szabgab/fix-typo-in-template 
fix typo in template
 2025-04-16 20:46:35 +00:00
Gabor Szabo
4c7e85ba82 fix typo 2025-04-10 08:48:51 +03:00
Gabor Szabo
9693c4af05 fix typo 2025-04-10 08:28:13 +03:00
Gabor Szabo
ee59e22603 Remove the book.multilingual field 
As it is seems it has never been in real use.

See #2636
 2025-04-06 13:27:13 +03:00
Eric Huss
4f698f813c
Merge pull request #2622 from szabgab/warn-on-invalid-configuration-field 
warn on invalid fields in the root of book.toml
 2025-04-03 18:23:26 +00:00
Eric Huss
97f1948681 Make the unexpected case explicit that it is an internal error 
The current code has the `else` clause as unreachable, and the text it
has isn't clear that is the case.
 2025-04-03 11:17:25 -07:00
Guillaume Gomez
0ed1cbe486 Fix JS error 2025-04-02 21:03:12 +02:00
Guillaume Gomez
2c382a58d3 Greatly speed up search index load 2025-04-02 21:03:12 +02:00
Guillaume Gomez
4886c92fa4 Finish moving resources around 2025-03-31 21:18:22 +02:00
Guillaume Gomez
195d97a514 Move JS files into front-end/js 2025-03-31 21:18:22 +02:00
Guillaume Gomez
e954e872f0 Move css and font files into front-end 2025-03-31 21:18:22 +02:00
Guillaume Gomez
e74b4b0507 Move template files into front-end/templates folder 2025-03-31 21:18:22 +02:00
Eric Huss
54d8d37b77 Fix eslint errors 
This updates the ecmaVersion due to the ?? nullish coalescing operator.
 2025-03-31 11:50:13 -07:00
Tyler Mandry
20eea0b41e Add "Auto" option to theme menu 
This switches between light and dark based on the OS, and provides a way
to remove a saved preference.
 2025-03-31 11:37:06 -07:00
Tyler Mandry
8835bdc47e Switch theme when preferred color scheme changes 2025-03-31 11:34:40 -07:00
Eric Huss
7a1977a78c
Merge pull request #2613 from szabgab/avoid-duplicate-entries 
Avoid using the same file twice in SUMMARY.md
 2025-03-31 18:15:16 +00:00
Eric Huss
b20b1757a9 Add footnote backreferences, and update styling 
This makes several changes to how footnotes are rendered:

- Backlinks are now included, which links back to the reference so you
  can continue reading where you left off.
- Footnotes are moved to the bottom of the page. This helps with the
  implementation of numbering, and is a style some have requested. I
  waffled a lot on this change, but supporting the in-place style was
  just adding too much complexity.
- Footnotes are now highlighted when you click on a reference.
- Some of the spacing for elements within a footnote has now been fixed
  (such as supporting multiple paragraphs).
- Footnote navigation now scrolls to the middle of the page.

This is an alternative to https://github.com/rust-lang/mdBook/pull/2475

Closes https://github.com/rust-lang/mdBook/issues/1927
Closes https://github.com/rust-lang/mdBook/issues/2169
Closes https://github.com/rust-lang/mdBook/issues/2595
 2025-03-30 06:44:59 -07:00
Gabor Szabo
1bc2ebd775 warn on invalid fields in root of book.toml 2025-03-28 10:56:41 +03:00
Guillaume Gomez
861940ba4b Fix eslint warnings 2025-03-23 10:06:12 +01:00
Guillaume Gomez
418d677584 Improve warning message when search index is too big 2025-03-22 17:49:30 +01:00
Guillaume Gomez
a0eb8c0a0e Remove JSON search file 2025-03-22 17:48:16 +01:00
Gabor Szabo
67b4260021 Avoid using the same file twice in SUMMARY.md 
See #2612
 2025-03-22 14:55:49 +02:00
Eric Huss
6d6bee0dc9
Merge pull request #2589 from szabgab/test/cant_open_summary_md 
[test] error Couldn't open SUMMARY.md in load_book
 2025-03-16 17:35:31 +00:00
Gabor Szabo
5fa9f12427 try to fix expected error on windows 2025-03-09 19:13:53 +02:00
Eric Huss
74200f7395 Fix search not showing in sub-directories 
This fixes a problem where the search was not displaying in
sub-directories. The problem was that `searcher.js` only exists in one
place, and was loading `searchindex.json` with a relative path. However,
when loading from a subdirectory, it needs the appropriate `..` to reach
the root of the book.
 2025-03-09 09:10:50 -07:00
Gabor Szabo
a7ca2e169f [test] error Couldn't open SUMMARY.md in load_book 2025-03-09 14:40:00 +02:00
Gabor Szabo
4f0dba8fdb check content of the error message 
in suffix_items_cannot_be_followed_by_a_list
 2025-03-05 17:27:15 +02:00
Gabor Szabo
0fb814c6d6 eliminate needless_late_init 
https://rust-lang.github.io/rust-clippy/master/index.html#needless_late_init
 2025-03-04 17:34:08 +02:00
Gabor Szabo
e7e3317ff0 remove unnecessary dots from docs 2025-03-04 17:06:21 +02:00
Gabor Szabo
e7418f21f9 Test failure in SUMMARY.md when item is not a link 2025-03-03 10:33:27 +02:00
Eric Huss
66ded2302f Fix playground edition detection 2025-02-26 05:50:25 -08:00
Eric Huss
98abb22be1
Merge pull request #1368 from notriddle/hash-files 
feat(html): cache bust static files by adding hashes to file names
 2025-02-20 18:32:17 +00:00
Eric Huss
ab304e7d38 More code simplification 2025-02-20 10:25:14 -08:00