Struct mdbook::config::Search
[−]
[src]
pub struct Search { pub limit_results: u32, pub teaser_word_count: u32, pub use_boolean_and: bool, pub boost_title: u8, pub boost_hierarchy: u8, pub boost_paragraph: u8, pub expand: bool, pub heading_split_level: u8, pub copy_js: bool, }
Configuration of the search functionality of the HTML renderer.
Fields
limit_results: u32
Maximum number of visible results. Default: 30
.
The number of words used for a search result teaser. Default: 30
,
use_boolean_and: bool
Define the logical link between multiple search words.
If true, all search words must appear in each result. Default: true
.
boost_title: u8
Boost factor for the search result score if a search word appears in the header.
Default: 2
.
boost_hierarchy: u8
Boost factor for the search result score if a search word appears in the hierarchy.
The hierarchy contains all titles of the parent documents and all parent headings.
Default: 1
.
boost_paragraph: u8
Boost factor for the search result score if a search word appears in the text.
Default: 1
.
expand: bool
True if the searchword micro
should match microwave
. Default: true
.
heading_split_level: u8
Documents are split into smaller parts, seperated by headings. This defines, until which
level of heading documents should be split. Default: 3
. (### This is a level 3 heading
)
copy_js: bool
Copy JavaScript files for the search functionality to the output directory?
Default: true
.
Trait Implementations
impl Debug for Search
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Clone for Search
[src]
fn clone(&self) -> Search
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialEq for Search
[src]
fn eq(&self, __arg_0: &Search) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Search) -> bool
[src]
This method tests for !=
.