Struct mdbook_angular::Config

pub struct Config {
    pub background: bool,
    pub experimental_builder: bool,
    pub playgrounds: bool,
    pub tsconfig: Option<PathBuf>,
    pub inline_style_language: String,
    pub optimize: bool,
    pub polyfills: Vec<String>,
    /* private fields */
}

Configuration for mdbook-angular

Fields

background: bool

Whether to enable the experimental background builder

Enabling this option runs the angular build in a background process, triggering a watch instead of an entire new build whenever mdbook notices a change. This is considerably faster.

This option requires the [Config.experimental_builder] option to be enabled. It only works on builds with the “background” feature enabled, and it only works on platforms rustc considers “unix”. This option is no-op for commands that don’t watch the book source for changes.

Default value: false

experimental_builder: bool

Whether to use an experimental builder (requires angular ≥ 16.2.0)

If enabled, all chapters in the book will be built in a single go. If disabled, every chapter is built separately as angular application.

Default value: false

playgrounds: bool

Whether playgrounds are enabled by default

This can be overridden via playground or no-playground tag on every individual code block or {{#angular}} tag.

Default value: true

tsconfig: Option<PathBuf>

Path to a tsconfig to use for building, relative to the book.toml file

inline_style_language: String

The inline style language the angular compiler should use

Default value: "css"

optimize: bool

Whether to optimize the angular applications

This option is ignored if background is active

Default value: false

polyfills: Vec<String>

Polyfills to import, if any

Note: zone.js is always included as polyfill.

This only supports bare specifiers, you can’t add relative imports here.

Implementations

impl Config

pub fn read<P: AsRef<Path>>(root: P) -> Result<Self>

Read mdbook-angular Config from the book.toml file inside the given folder.

Errors

This function will return an error if reading the book.toml fails or if the book contains an invalid configuration.

pub fn new(ctx: &RenderContext) -> Result<Self>

Create mdbook-angular configuration Config from the given render context.

Errors

This function fails if the context contains an invalid configuration.