{"route":"/en-US-v0.13.1/reference/html/","title":"HTML","description":"Documentation for functions related to HTML in Typst.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"exporting-as-html","name":"Exporting as HTML","children":[{"id":"command-line","name":"Command Line","children":[]},{"id":"web-app","name":"Web App","children":[]}]},{"id":"html-specific-functionality","name":"HTML-specific functionality","children":[]},{"id":"definitions","name":"Definitions","children":[]}],"body":{"kind":"category","content":{"name":"html","title":"HTML","details":"
\n

Typst's HTML export is currently under active development. The feature is still\nvery incomplete and only available for experimentation behind a feature flag. Do\nnot use this feature for production use cases. In the CLI, you can experiment\nwith HTML export by passing --features html or setting the TYPST_FEATURES\nenvironment variables to html. In the web app, HTML export is not available at\nthis time. Visit the tracking issue\nto follow progress on HTML export and learn more about planned features.

\n
\n

HTML files describe a document structurally. The aim of Typst's HTML export is\nto capture the structure of an input document and produce semantically rich HTML\nthat retains this structure. The resulting HTML should be accessible,\nhuman-readable, and editable by hand and downstream tools.

\n

PDF, PNG, and SVG export, in contrast, all produce visual representations of a\nfully-laid out document. This divergence in the formats' intents means that\nTypst cannot simply produce perfect HTML for your existing Typst documents. It\ncannot always know what the best semantic HTML representation of your content\nis.

\n

Instead, it gives you full control: You can check the current export format\nthrough the target function and when it is set to HTML, generate raw HTML\nelements. The primary intended use of these elements is in\ntemplates and show rules. This way, the document's contents can be fully\nagnostic to the export target and content can be shared between PDF and HTML\nexport.

\n

Currently, Typst will always output a single HTML file. Support for outputting\ndirectories with multiple HTML documents and assets, as well as support for\noutputting fragments that can be integrated into other HTML documents is\nplanned.

\n

Typst currently does not output CSS style sheets, instead focussing on emitting\nsemantic markup. You can of course write your own CSS styles and still benefit\nfrom sharing your content between PDF and HTML. For the future, we plan to\ngive you the option of automatically emitting CSS, taking more of your existing\nset rules into account.

\n

Exporting as HTML

\n

Command Line

\n

Pass --format html to the compile or watch subcommand or provide an output\nfile name that ends with .html. Note that you must also pass --features html\nor set TYPST_FEATURES=html to enable this experimental export target.

\n

When using typst watch, Typst will spin up a live-reloading HTTP server. You\ncan configure it as follows:

\n\n

Web App

\n

Not currently available.

\n

HTML-specific functionality

\n

Typst exposes HTML-specific functionality in the global html module. See below\nfor the definitions it contains.

","items":[{"name":"elem","route":"/en-US-v0.13.1/reference/html/elem/","oneliner":"An HTML element that can contain Typst content.","code":true},{"name":"frame","route":"/en-US-v0.13.1/reference/html/frame/","oneliner":"An element that lays out its content as an inline SVG.","code":true}],"shorthands":null}}}