actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1637 from notriddle/no-headers 

Include chapters with no headers in the search index
This commit is contained in:
Eric Huss 2021-09-03 10:10:07 -07:00 committed by GitHub
parent 48b5e52f62 2a8af1c21d
commit 9634798eb7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 496 additions and 261 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/renderer/html_handlebars/search.rs
View File

@ -165,7 +165,12 @@ fn render_item(
} }
} }
if !heading.is_empty() { if !body.is_empty() || !heading.is_empty() {
if heading.is_empty() {
if let Some(chapter) = breadcrumbs.first() {
heading = chapter.clone();
}
}
// Make sure the last section is added to the index // Make sure the last section is added to the index
add_doc( add_doc(
index, index,

1
tests/dummy_book/src/SUMMARY.md
View File

@ -12,6 +12,7 @@
- [Recursive](first/recursive.md) - [Recursive](first/recursive.md)
- [Markdown](first/markdown.md) - [Markdown](first/markdown.md)
- [Unicode](first/unicode.md) - [Unicode](first/unicode.md)
- [No Headers](first/no-headers.md)
- [Second Chapter](second.md) - [Second Chapter](second.md)
- [Nested Chapter](second/nested.md) - [Nested Chapter](second/nested.md)

3
tests/dummy_book/src/first/no-headers.md Normal file
View File

@ -0,0 +1,3 @@
Capybara capybara capybara.
Capybara capybara capybara.

12
tests/rendered_output.rs
View File

@ -34,6 +34,7 @@ const TOC_SECOND_LEVEL: &[&str] = &[
"1.3. Recursive", "1.3. Recursive",
"1.4. Markdown", "1.4. Markdown",
"1.5. Unicode", "1.5. Unicode",
"1.6. No Headers",
"2.1. Nested Chapter", "2.1. Nested Chapter",
]; ];
@ -631,6 +632,7 @@ mod search {
let introduction = get_doc_ref("intro.html#introduction"); let introduction = get_doc_ref("intro.html#introduction");
let some_section = get_doc_ref("first/index.html#some-section"); let some_section = get_doc_ref("first/index.html#some-section");
let summary = get_doc_ref("first/includes.html#summary"); let summary = get_doc_ref("first/includes.html#summary");
let no_headers = get_doc_ref("first/no-headers.html");
let conclusion = get_doc_ref("conclusion.html#conclusion"); let conclusion = get_doc_ref("conclusion.html#conclusion");
let bodyidx = &index["index"]["index"]["body"]["root"]; let bodyidx = &index["index"]["index"]["body"]["root"];
@ -644,13 +646,21 @@ mod search {
assert_eq!(docs[&some_section]["body"], ""); assert_eq!(docs[&some_section]["body"], "");
assert_eq!( assert_eq!(
docs[&summary]["body"], docs[&summary]["body"],
"Dummy Book Introduction First Chapter Nested Chapter Includes Recursive Markdown Unicode Second Chapter Nested Chapter Conclusion" "Dummy Book Introduction First Chapter Nested Chapter Includes Recursive Markdown Unicode No Headers Second Chapter Nested Chapter Conclusion"
); );
assert_eq!( assert_eq!(
docs[&summary]["breadcrumbs"], docs[&summary]["breadcrumbs"],
"First Chapter » Includes » Summary" "First Chapter » Includes » Summary"
); );
assert_eq!(docs[&conclusion]["body"], "I put <HTML> in here!"); assert_eq!(docs[&conclusion]["body"], "I put <HTML> in here!");
assert_eq!(
docs[&no_headers]["breadcrumbs"],
"First Chapter » No Headers"
);
assert_eq!(
docs[&no_headers]["body"],
"Capybara capybara capybara. Capybara capybara capybara."
);
} }
// Setting this to `true` may cause issues with `cargo watch`, // Setting this to `true` may cause issues with `cargo watch`,

734
tests/searchindex_fixture.json
View File

File diff suppressed because it is too large Load Diff