Masthead Documentation
Documentation for usage of the Masthead platform
Basics
-
Getting started
Everything you need to get started with Masthead, from creating your first site to understanding the core concepts behind the platform.
-
How Masthead works
Understand the philosophy behind Masthead, how themes define the editing experience, and why the platform is designed around content rather than page building.
-
Importing content
Importing your site from Hugo, or importing HTML or markdown files directly as posts or pages.
-
Managing your site
Configure the global settings of your Masthead site, including its identity, homepage, tags, custom domain and other site-wide options.
Self Hosting
For Developers
-
Masthead CLI
A complete guide to the Masthead CLI, including installation, local previews, validation and packaging.
-
Creating a custom theme
An introduction to building Masthead themes, including the development workflow, theme structure and core concepts.
-
Theme Manifest
Learn how the theme manifest describes your theme, exposes configuration and serves as the entry point for every Masthead theme.
-
Templates
Learn how Masthead renders websites using Liquid templates and how each template contributes to the structure of a theme.
-
Theme Tokens
Theme tokens define the site-wide settings exposed by a theme. Masthead automatically turns these declarations into a configurable editor for site owners.
-
Page metadata
Page metadata defines the settings available on individual pages, allowing themes to expose page-specific configuration through the same generated editor as theme tokens.
-
Objects
Group related fields into a single configurable value using objects. Objects make complex configuration easier to organize and consume from templates.
-
Lists
Use lists to model repeatable content such as navigation menus, feature lists and social links. Each item shares the same structure and can be reordered directly from the editor.
-
Theme Pages
Theme pages allow themes to provide reusable page templates with their own editor, exposing only the configuration required for that specific type of page.
-
Liquid
Learn how Masthead uses Liquid to render themes and discover the variables and filters available while building templates.
-
Assets
Learn how to bundle static files with your theme and reference them from Liquid templates and CSS using the asset_url filter.
-
Preview content
Learn how to provide sample content for the Masthead preview server, making it possible to develop and test themes without a running Masthead instance.
-
Packaging
Package your theme into a distributable archive, validate it and prepare it for installation or publication.