[−][src]Struct mdbook::config::Search
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, 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 Clone for Search
[src]
impl Default for Search
[src]
impl PartialEq<Search> for Search
[src]
impl Debug for Search
[src]
impl StructuralPartialEq for Search
[src]
impl Serialize for Search
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<'de> Deserialize<'de> for Search where
Search: Default,
[src]
Search: Default,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl Send for Search
impl Sync for Search
impl Unpin for Search
impl UnwindSafe for Search
impl RefUnwindSafe for Search
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,