mdbook-angular

mdbook-angular is a custom renderer for mdBook that enables authors to embed live, running Angular applications directly within their documentation. It transforms static Angular code samples into interactive examples, allowing readers to see components in action and experiment with inputs and actions via an optional playground.

Key Features

• Live Angular Applications — Bootstraps Angular components from code blocks or file references as separate, running applications on the page.
• Interactive Playgrounds — Automatically generates UI controls for component inputs and actions, enabling reader interaction with the live examples.
• Flexible Integration — Supports inline code blocks with angular tags or {{#angular}} directives pointing to external component files.
• Customizable Build — Offers multiple builders (experimental, slow, background) and configuration options for Angular build settings like optimization and polyfills.
• Code Display Control — Provides flags to hide, collapse, or show source code, and control playground visibility per code sample.

Philosophy

mdbook-angular prioritizes seamless integration of interactive Angular examples into technical documentation, enhancing learning by making code samples executable and explorable directly in the browser.