Loewe1000/manifesto

The first HTML template ๐Ÿ“š powered by Typst using TailwindCSS

โ˜… 0Forks 0GitHub โ†—Compare

README

Manifesto for Typst

Manifesto ๐Ÿ“š is the first HTML Typst documentation template for packages, built to be very easy to use. It is 100% written in Typst, responsive and directly uses your typst.toml to automatically get your package information.

Report a bug โ€” Forum

You are free to check either this example from bone or this one from zap.

Preview example

Quick usage

The template is very easy to use, and will transform your whole project into a stunning online documentation in just a second.

#import "@preview/manifesto:0.1.1": template

#show: it => template(it, toml: toml("/typst.toml"))

= My first title

Lorem ipsum

Options

The template function accepts a few parameters to customize the data displayed on the website.

Option Default value Description
name The name of your package
toml none The path to the typst.toml file
version none Your package version
description none Your package description
repository none Your package repository URL (e.g. GitHub)
license none Your package license

Note that giving the toml file is aready enough, and will fill in the other options.

Contributing

I highly welcome contributions ๐ŸŒฑ! Creating and maintaining this template takes time and love. If you'd like to help, don't hesitate to join the journey ๐Ÿคฉ!

Contributors

l0uisgrange

Issues