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

1260 commits

Author SHA1 Message Date
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
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
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
Eric Huss
fbc21592af Some clippy cleanup 2025-02-20 10:23:47 -08:00
Eric Huss
e7b69114ed Remove some code duplication 2025-02-20 10:19:04 -08:00
Michael Howell
8a9ecd212d Fix, and test, the no-js toc sidebar with hashed resources 
To make this work, I need to break the circular dependency and
stop hashing toc.html itself.
 2025-02-20 10:27:18 -07:00
Eric Huss
2a4e5583ab Rewrite test to use tempfile 
We don't want to be writing to arbitrary directories, and this
seems to make the test a little simpler.
 2025-02-20 08:48:16 -08:00
Eric Huss
3978612611 Update some comments and formatting 2025-02-20 08:47:03 -08:00
Eric Huss
ddba36b24c
Merge pull request #2524 from WaffleLapkin/first-last-of-type-footnote 
nicer style rules for margin around footnote defs
 2025-02-17 18:12:15 +00:00
Eric Huss
5777a0edc4 Fix issue with None source_path 
This fixes an issue where mdbook would panic if a non-draft chapter has
a None source_path when generating the search index. The code was
assuming that only draft chapters would have that behavior. However, API
users can inject synthetic chapters that have no path on disk.

This updates it to fall back to the path, or skip if neither is set.
 2025-02-17 09:41:52 -08:00
Michael Howell
879449447f feat(html): cache bust static files by adding hashes to file names 
Closes rust-lang#1254
 2025-02-13 10:39:22 -07:00
Eric Huss
2af44a396f Add context when rustdoc command is not found 2025-02-03 11:02:53 -08:00
Eric Huss
09a37284b0 Add output.html.search.chapter 
This config setting provides the ability to disable search indexing on a
per-chapter (or sub-path) basis.

This is structured to possibly add additional settings, such as perhaps
a score multiplier or other settings.
 2025-01-27 19:45:50 -08:00
Eric Huss
dff5ac64e5
Merge pull request #2458 from dcampbell24/display-for-clean 
Display what is removed from mdbook clean.
 2025-01-25 21:54:30 +00:00
Eric Huss
0ee565a5ff
Merge pull request #2530 from max-heller/rust-hidelines 
fix: make line hiding in Rust code blocks consistent with `rustdoc`
 2025-01-25 21:50:47 +00:00
Michael Howell
74d48f5ad2 Prevent the real sidebar position from becoming unsynced from the JS 
This way, whatever behavior the browser might use for checkboxes
will apply to the CSS class, localStorage, and the visible state.
 2025-01-23 10:18:21 -07:00
Waffle Lapkin
64cca1399b
nicer style rules for margin around footnote defs 
previous implementation used `:not(.fd) + .fd` and `.fd + :not(.fd)`.
the latter selector caused many problems:
- it doesn't select footnote defs which are last children
  (this can be easily triggered in a blockquote)
- it changes the margin of the next sibling, rather than the footnote def
  itself, which can also *shrink* margin for elements with big margins
  (this happens to headings)
- because it applies to the next sibling it is also quite hard to
  override in user styles, since it may apply to any element
  
this commit replaces the latter selector with `:not(:has(+ .fd))`,
which fixes all of the mentioned problems.
 2025-01-21 01:21:53 +01:00
Max Heller
d325e821cd
fix: make line hiding in Rust code blocks consistent with rustdoc 
Requires a space following a `#` for a line to be hidden.
 2025-01-20 11:43:39 -05:00
Guillaume Gomez
ac3a7faa54 Fix display of sidebar when JS is disabled 2025-01-20 17:29:07 +01:00
Michael Howell
f92eac4acd Ignore fragment when figuring out sidebar items 2025-01-02 10:34:03 -07:00
Eric Huss
42f18d1e51 Stabilize 2024 flag 
The 2024 edition is now stable on nightly, so the `-Z` flag is no longer necessary.
 2024-11-23 15:25:29 -08:00
David Campbell
abf3e4ab50
Display what is removed from mdbook clean. 
This is based off of [cargo's][1] clean command. cargo is licensed
under MIT or Apache-2.0.

[1]: https://github.com/rust-lang/cargo
 2024-11-22 15:10:51 -05:00
eureka-cpu
8f024dabc3 fix init --title option failure when git user is not configured 2024-11-18 11:10:11 -08:00
Michael Howell
68e3572278 Fix inadvertently broken folding behavior 2024-11-06 15:47:12 -07:00
Eric Huss
271bbba7dd
Merge pull request #2414 from notriddle/on2 
Load the sidebar toc from a shared JS file or iframe
 2024-11-02 23:56:19 +00:00
Eric Huss
86ff2e1e6b
Merge pull request #2465 from ehuss/footnote-line-height 
Set line-height of superscripts to 0
 2024-11-02 23:19:27 +00:00
Eric Huss
6ef7cc0ccb Set line-height of superscripts to 0 
This changes it so that superscript (and in particular footnote tags)
do not bump the line spacing of previous lines.
 2024-11-02 16:12:07 -07:00
Eric Huss
47384c1f18
Merge pull request #2463 from Pistonight/bug/theme_popup 
fix: themes broken when localStorage has invalid theme id stored
 2024-11-02 22:48:17 +00:00
Pistonight
4a330ae36f fix: themes broken when localStorage has invalid theme id stored 2024-10-31 19:02:35 -07:00
Guillaume Gomez
d93fbc0f6b Improve theme support when JS is disabled 2024-10-29 16:20:41 +01:00
Jackie Harris
d0dd16c527 Enhance syntax highlighting 
Add syntax highlighting for `hljs-attr` and `hljs-section` CSS classes,
consistent with the Ayu theme.
 2024-10-17 12:25:15 -05:00
Hamir Mahal
f9add3e936
fix: formatting in src/ and tests/ directories 2024-09-21 15:56:13 -07:00
Hamir Mahal
1fd9656291
style: simplify string formatting for readability 2024-09-21 15:53:59 -07:00
Guillaume Gomez
b3c23c5f88 Add credits for clipboard image 2024-08-11 16:18:19 +02:00
Guillaume Gomez
f1a446fb02 Unify copy to clipboard icon with docs.rs, rustdoc and crates.io 2024-08-02 11:55:17 +02:00
Michael Howell
203685e91c Make the sidebar work without JS 
Uses an iframe instead. The downside of iframes comes from them
not necessarily being same-origin as the main page (particularly
with `file:///` URLs), which can cause themes to fall out of sync,
but that's not a problem here since themes don't work without JS
anyway.
 2024-07-16 12:38:00 -07:00
Michael Howell
2cb5b85ab2 Load the sidebar toc from a shared JS file 
Before this change, the Rust `unstable-book` is 88MiB.
With this change, it becomes 15MiB. Other pages might not be
as extreme, but it's expected to help any book like this.

This change is so drastic because, if every chapter has a link to
every other chapter, the result is *O*(n<sup>2</sup>) text output.
 2024-07-15 18:51:32 -07:00
Eric Huss
1e4d4887e1 Add support for Rust Edition 2024 2024-06-12 15:53:56 -07:00
Eric Huss
65932289f7 Revert "Merge pull request #2381 from ehuss/update-pulldown-cmark" 
This reverts commit 8884008b4d,
(https://github.com/rust-lang/mdBook/pull/2381) reversing
changes made to 3d6caa504f.

The `pulldown_cmark` types are a public API, which I did not realize.
 2024-05-16 18:08:09 -07:00
Eric Huss
965f7bde0d Fix dead_code warning for arg_watcher 2024-05-16 17:38:52 -07:00
Eric Huss
af3012b0f2 Update pulldown-cmark to 0.11 2024-05-16 14:17:19 -07:00