What mothwing and mothwing/html export, for scripts that build a site themselves and for typing mothwing.config.js.
fasset(
file: string,
content: string | Uint8Array<ArrayBufferLike>
): AssetA file for the build, made from data: a search index, a feed, a generated image. The build writes it, and a page links to it by this value, its URL with a hash of the content, like the JS and CSS links: <input data-index="{{ search.index }}"> -> data-index="/search.json?v=1a2b3c4d". The hash only changes when the content does, so browsers and CDNs can keep it until then.
fbuild(site: Site): Promise<void>The production build, from an empty build folder.
fclean(site: Site): Promise<void>Removes the build folder, what the production build starts with.
fdefineConfig(config: Config): ConfigGives the config its types in your editor, it's returned as it is.
fdev(
site: Site,
{ host, port }?: { host?: string; port?: number; }
): Promise<void>Builds, serves and rebuilds what changes.
fescapeHtml(text: string): stringEscapes the characters that mean something in HTML, &<>"', so the text shows as it is.
fhtml(strings: TemplateStringsArray, ...values: any[]): HtmlA template tag for HTML in .data.js files. What goes into it is escaped, unless it's Html already: another html..., raw(), or a list of those. null, undefined and false are left out.
floadConfig(root?: string): Promise<Site>Imports a folder's mothwing.config.js and resolves it, what the CLI does before it builds.
flog(type: string, message: string): voidPrints a line the way mothwing's own are, [ HTML ] 2026-01-01 12:00:00 message, for hooks to report in.
fraw(value: string): HtmlMarks a string as HTML already, for html... to put in without escaping. Only for HTML you trust.
frenderSite(
site: Site,
{ only }?: { only?: Set<string>; }
): Promise<{ deps: Record<string, string[]>; written: number; }>Renders the pages into an existing build, as dev does after a change. With only, just those pages, and the sitemaps are left as they are.
fresolveConfig(config: Config, root: string): SiteChecks a config and fills in its defaults. An unknown option, or one without a domain, throws.
fslug(name: string): stringMakes a name safe for a URL, for the slugs of generated pages.
funescapeHtml(html: string): stringUndoes escapeHtml, for text that comes escaped, like the value of an attribute.
cnew Html(value: string): HtmlHTML that's safe to put in as-is.
value: stringtoString(): stringTtype AssetNo documentation
path: stringcontent: string | Uint8Array<ArrayBufferLike>url: stringtoString(): string... put it in as it isTtype ConfigWhat a site's mothwing.config.js default exports. Only domain is needed. Paths are relative to src unless they say otherwise. The extras (minify to activeLinks) are off until asked for: true turns one on as it comes, an object with its own settings.
domain: stringsrc?: stringout?: stringpages?: stringpartials?: stringdata?: stringnotFound?: stringjs?: JsConfigsass?: Record<string, string>exclude?: string[]rerender?: string[]seo?: SeoConfigminify?: booleancsp?: boolean | Record<string, string>sitemap?: boolean | SitemapConfigrobots?: boolean | RobotsConfigcname?: booleanactiveLinks?: boolean | ActiveLinktags?: Record<string, TagFunction>transforms?: Transform[]after?: Hook[]esbuild?: BuildOptionsTtype JsConfigEach file is bundled to the same path in the build, js/index.js -> /js/index.js.
scripts?: string[]modules?: string[]chunks?: stringTtype RobotsConfigWhat robots.txt turns away.
block?: string[]disallow?: string[]Ttype RouteA page to write. Most come one to a file in the pages folder, a [name].html file gives one per item. Its props can have files, more files to write, by their path in the build.
source: stringoutput: stringurl: stringprops: Record<string, any>sources: string[]Ttype SeoConfigWhat <x-seo> fills its tags with when a page doesn't say.
siteName?: stringlocale?: stringimage?: null | { src: string; width: number; height: number; alt: string; }maxTitle?: numbermaxDescription?: numberTtype SiteWhat Config becomes after resolveConfig, and what tags, transforms and hooks get: every option filled in with its default, its folders absolute, and each extra either false or its settings.
domain: stringpartials: stringdata: stringnotFound: stringsass: Record<string, string>rerender: string[]minify: booleancname: booleantags: Record<string, TagFunction>transforms: Transform[]after: Hook[]esbuild: BuildOptionsurl: stringroot: stringsrc: stringout: stringpages: stringexclude: string[]js: Required<JsConfig>seo: Required<SeoConfig>csp: false | Record<string, string>sitemap: false | Required<SitemapConfig>robots: false | Required<RobotsConfig>activeLinks: false | ActiveLinkTtype SitemapConfigHow sitemap.xml is split and dated.
sections?: string[]dates?: booleancbActiveLink(
href: string,
route: Route
): false | "page" | "section" | undefinedDecides what a link on a page is to it: "page" for the page itself, "section" for a section it's in, false for neither. undefined leaves it to the default.
cbHook(build: { site: Site; routes: Route[]; dev: boolean; }): anyRun once the pages are written, dev is true on dev renders.
cbTagFunction(
tag: { attrs: Record<string, string | true>; route: Route; site: Site; }
): string | string[]Returns the HTML a tag turns into. A list is one line each, indented like the tag.
cbTransform(html: string, route: Route, site: Site): stringRun on every page's HTML once its placeholders are filled, returns the HTML to write.