Compare commits

..

8 Commits

Author SHA1 Message Date
Ramon Buckland
a00ccf8c72 Updated the documentation for new preprocessor format (#787)
* Updated the documentation for new preprocessor format

* adjusted the descriptions for preprocessors
2018-09-10 18:58:55 +08:00
Michael Bryan
18a36ec1fa Fixed the build.use-default-preprocessors flag 2018-09-09 19:02:50 +08:00
Michael Bryan
40ede19103 Got my logic around the wrong way 2018-08-30 22:57:01 +08:00
Michael Bryan
4d7027f8a7 You can normally use default preprocessors by default 2018-08-30 22:51:46 +08:00
Michael Bryan
d0a6d7c87c Users can now manually specify whether a preprocessor should run for a renderer 2018-08-30 22:33:33 +08:00
Michael Bryan
995efc22d5 Made sure preprocessors get their renderer's name 2018-08-30 21:51:18 +08:00
Michael Bryan
a0702037bd A preprocessor is told which render it's running for 2018-08-30 21:37:29 +08:00
Michael Bryan
769fd94868 The preprocessor trait now returns a modified book instead of editing in place 2018-08-30 21:33:56 +08:00
4 changed files with 6 additions and 21 deletions

View File

@@ -114,12 +114,6 @@ pub mod renderer;
pub mod theme;
pub mod utils;
/// The current version of `mdbook`.
///
/// This is provided as a way for custom preprocessors and renderers to do
/// compatibility checks.
pub const MDBOOK_VERSION: &str = env!("CARGO_PKG_VERSION");
pub use book::BookItem;
pub use book::MDBook;
pub use config::Config;

View File

@@ -21,21 +21,12 @@ pub struct PreprocessorContext {
pub config: Config,
/// The `Renderer` this preprocessor is being used with.
pub renderer: String,
/// The calling `mdbook` version.
pub mdbook_version: String,
__non_exhaustive: (),
}
impl PreprocessorContext {
/// Create a new `PreprocessorContext`.
pub(crate) fn new(root: PathBuf, config: Config, renderer: String) -> Self {
PreprocessorContext {
root,
config,
renderer,
mdbook_version: ::MDBOOK_VERSION.to_string(),
__non_exhaustive: (),
}
PreprocessorContext { root, config, renderer }
}
}

View File

@@ -26,6 +26,8 @@ use book::Book;
use config::Config;
use errors::*;
const MDBOOK_VERSION: &str = env!("CARGO_PKG_VERSION");
/// An arbitrary `mdbook` backend.
///
/// Although it's quite possible for you to import `mdbook` as a library and
@@ -64,7 +66,6 @@ pub struct RenderContext {
/// renderers to cache intermediate results, this directory is not
/// guaranteed to be empty or even exist.
pub destination: PathBuf,
__non_exhaustive: (),
}
impl RenderContext {
@@ -77,10 +78,9 @@ impl RenderContext {
RenderContext {
book: book,
config: config,
version: ::MDBOOK_VERSION.to_string(),
version: MDBOOK_VERSION.to_string(),
root: root.into(),
destination: destination.into(),
__non_exhaustive: (),
}
}

View File

@@ -27,7 +27,7 @@
<!-- Custom theme stylesheets -->
{{#each additional_css}}
<link rel="stylesheet" href="{{ ../path_to_root }}{{ this }}">
<link rel="stylesheet" href="{{ this }}">
{{/each}}
{{#if mathjax_support}}
@@ -235,7 +235,7 @@
<!-- Custom JS scripts -->
{{#each additional_js}}
<script type="text/javascript" src="{{ ../path_to_root }}{{this}}"></script>
<script type="text/javascript" src="{{ path_to_root }}{{this}}"></script>
{{/each}}
{{#if is_print}}