Skip to content

A collection of my own custom components for open-source typst documents.

License

Notifications You must be signed in to change notification settings

kylecurtis/typst-components

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

About

What is this project?

This project was started so that I can better understand typst, and so I can have custom components for my own open-source documents which are not reliant on any other dependencies and easy to import.

Why aren't these components available in Typst Universe?

I made these for my own typst documents using my own design preferences, not as a long-term maintainable project for others. That being said, I made these components with the awareness that others may use them, so they are designed to be simple to use and customize.


Usage

If you do use my components, it's very simple to add to existing documentation:

  1. Clone the repo: git clone https://github.com/kylecurtis/typst-components.git
  2. Copy the .typ component file from the lib/ directory you wish to add to your documentation.
  3. Paste the file in your own documentation directory.
  4. Import the components by adding this line at the top of your document files:
  • #import "file-name.typ": *
  • Example: #import "admonitions.typ": *
  1. Look at the usage/ directory to see how each screenshot below is made.

Admonitions (Example)

Example Code

admonitions

About

A collection of my own custom components for open-source typst documents.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages