Skip to main content

Crate maudit

Crate maudit 

Source
Expand description

§Maudit Logo of Maudit, a crudely crown Logo of Maudit, a crudely crown

A dire coronation, a situation where nobility, power, or status becomes inextricably tied to disastrous circumstances.

A library for generating static websites with Rust.

Read the documentation on maudit.org, or join us on Discord.

§Crates

Maudit is a monorepo that contains the following crates (Rust packages):

NameDescriptionRegistryREADME
mauditLibrary for generating static websitesMaudit Crates.io VersionREADME
maudit-cliCLI and dev server to operate on Maudit projectsMaudit CLI Crates.io VersionREADME
maudit-macrosProcedural macros exposed by the library (e.g. #[route])Maudit Macros Crates.io VersionREADME
oubliLibrary for generating documentation websites with MauditOubli Crates.io VersionREADME

§Acknowledgements

Maudit is an open-source project born from Bruits, a Rust-focused collective 💛

You are currently reading Maudit API reference. For a more gentle introduction, please refer to our documentation.

Re-exports§

pub use sitemap::ChangeFreq;
pub use sitemap::SitemapOptions;

Modules§

assets
content
Core functions and structs to define the content sources of your website.
errors
Error types for Maudit.
maudmaud
Traits and methods for Maud, a macro for writing HTML templates.
route
Core traits and structs to define the pages of your website.
routing
sitemap

Macros§

content_sources
Helps to define all sources of content that should be loaded by coronate().
routes
Helps to define every route that should be build by coronate().
shortcode

Structs§

AssetsOptions
BuildOptions
Maudit build options. Should be passed to coronate().
BuildOutput
Metadata returned by coronate() after a successful build.
PageOutput
Metadata returned by coronate() for a single page after a successful build.
PrefetchOptions
StaticAssetOutput
Metadata returned by coronate() for a single static asset after a successful build.

Enums§

AssetHashingStrategy
PrefetchStrategy

Constants§

GENERATOR
The version of Maudit being used.

Functions§

coronate
👑 Maudit entrypoint. Starts the build process and generates the output files.
is_dev
Returns whether Maudit is running in development mode (through maudit dev).