[−][src]Struct mdbook::preprocess::IndexPreprocessor
A preprocessor for converting file name README.md
to index.md
since
README.md
is the de facto index file in markdown-based documentation.
Methods
impl IndexPreprocessor
[src]
Trait Implementations
impl Preprocessor for IndexPreprocessor
[src]
fn name(&self) -> &str
[src]
fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book>
[src]
fn supports_renderer(&self, _renderer: &str) -> bool
[src]
A hint to MDBook
whether this preprocessor is compatible with a particular renderer. Read more
impl Default for IndexPreprocessor
[src]
fn default() -> IndexPreprocessor
[src]
Auto Trait Implementations
impl Send for IndexPreprocessor
impl Sync for IndexPreprocessor
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, 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> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,