Struct fifthtry_mdbook::config::Search [−][src]
pub struct Search { pub enable: bool, 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, }
Expand description
Configuration of the search functionality of the HTML renderer.
Fields
enable: bool
Enable the search feature. Default: true
.
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: false
.
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, separated 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<'de> Deserialize<'de> for Search where
Search: Default,
[src]
impl<'de> Deserialize<'de> for Search where
Search: Default,
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl StructuralPartialEq for Search
[src]
Auto Trait Implementations
impl RefUnwindSafe for Search
impl Send for Search
impl Sync for Search
impl Unpin for Search
impl UnwindSafe for Search
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,