Skip to contents

Getting started

Starting a site, and building one.

mui_create_site()
Create a new site
mui_build_site()
Build the site

Configuration

What mui.config.yml says, what it falls back to, and the configuration the build is currently using.

mui_read_config() mui_validate_config()
Read a site configuration
mui_default_config()
Default site configuration
mui_config() mui_set_config()
The active site configuration

Design

The one palette both halves of the site read.

mui_theme()
The site's MUI theme

Section variants

How a section draws its items. These are the components a variants entry of your own returns, and the ones it replaces.

mui_card() mui_card_grid()
The shared card
mui_accordion()
The talks band
mui_showcase()
The applications band
mui_list() mui_timeline()
A band of rows
mui_prose()
A band of prose

Building a page of your own

The shell every page carries and the writer that turns one into a file - the pair a site needs to render a page this package does not build for it.

mui_app_shell()
The page shell
mui_render_page()
Render a page to a standalone HTML file