Page Metadata
Pages will have metadata associated with them: page title, description, tags, stylesheets, etc. Mountaineer specifies this metadata in the Python layer, during the initial render.
Each RenderBase schema implements a metadata attribute. This metadata
lets you customize the different fields that are injected in your
html <head> tag:
class Metadata(BaseModel):
title: str | None = None
metas: list[MetaAttribute] = []
links: list[LinkAttribute] = []
scripts: list[ScriptAttribute] = []
Title
Setting a page title is pretty straightforward. You just return a
Metadata instance within your render() function. Because the metadata
logic is located in-scope of your other business logic, you can access
the full suit of calculated values. This is helpful to conditionally
generate a dynamic title - like injecting a user's account name, number
of new messages, etc.
class MyRender(RenderBase):
pass
def render() -> MyRender:
return MyRender(
metadata=Metadata(
title="My Title"
)
)
Meta and Links
We provide a pretty vanilla syntax within Metadata so you can specify
any <meta> and <link> elements you'd like. We do this with the
recognition that only some meta tag values have been standardized, and
others are left to the browser implementations or web crawlers to parse
them appropriately.
You'll typically instantiate a <meta> tag like this:
class MyRender(RenderBase):
pass
def render() -> MyRender:
return MyRender(
metadata=Metadata(
metas=[
MetaAttribute(
name="og:meta",
content="Some meta content",
)
]
)
)
We have a limited number of helper <meta> constructors, particularly in
cases where there are standard definitions of complex meta values. For
more details on the supported Metadata and rendering options, check out
the Controller API docs.
Scripts
You can also inject <script> tags through metadata. This is useful for analytics, third-party widgets, or small bits of bootstrap logic that need to run before your app hydrates.
For external scripts, use src:
def render() -> MyRender:
return MyRender(
metadata=Metadata(
scripts=[
ScriptAttribute(
src="https://example.com/widget.js",
defer=True,
)
]
)
)
For inline scripts, use inline:
def render() -> MyRender:
return MyRender(
metadata=Metadata(
scripts=[
ScriptAttribute(
inline="window.APP_BOOTSTRAPPED = true;",
)
]
)
)
ScriptAttribute requires exactly one of src or inline. You can also pass standard attributes like defer, asynchronous, or extra values through optional_attributes.
Global Metadata
For metadata that you know should appear on every page (like stylesheets or global scripts), you can add a metadata tag to your app controller:
controller = AppController(
global_metadata=Metadata(
links=[LinkAttribute(rel="stylesheet", href="/static/main.css")],
scripts=[ScriptAttribute(src="https://example.com/app.js", defer=True)],
),
)