Skip to content

typst-community/typst-package-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The my-package Package

Version 0.1.0

A short description about the project and/or client.

Template adaptation checklist

  • Fill out README.md
    • Change the my-package package name, including code snippets
    • Check section contents and/or delete sections that don't apply
  • Check and/or replace LICENSE by something that suits your needs
  • Fill out typst.toml
  • Adapt Repository URLs in CHANGELOG.md
    • Consider only committing that file with your first release, or removing the "Initial Release" part in the beginning
  • Adapt or deactivate the release workflow in .github/workflows/release.yml
    • to deactivate it, delete that file or remove/comment out lines 2-4 (on: and following)

    • to use the workflow

      if configured correctly, whenever you create a tag v..., your package will be pushed onto a branch on the REGISTRY_REPO, from which you can then create a pull request against typst/packages

  • remove/replace the example test case
  • (add your actual code, docs and tests)
  • remove this section from the README

Getting Started

These instructions will get you a copy of the project up and running on the typst web app. Perhaps a short code example on importing the package and a very simple teaser usage.

#import "@preview/my-package:0.1.0": *

#show: my-show-rule.with()
#my-func()

Installation

A step by step guide that will tell you how to get the development environment up and running. This should example how to clone the repo and where to (maybe a link to the typst documentation on it), along with any pre-requisite software and installation steps.

$ First step
$ Another step
$ Final step

Usage

A more in-depth description of usage. Any template arguments? A complicated example that showcases most if not all of the functions the package provides? This is also an excellent place to signpost the manual.

#import "@preview/my-package:0.1.0": *

#let my-complicated-example = ...

Additional Documentation and Acknowledgments

  • Project folder on server:
  • Confluence link:
  • Asana board:
  • etc...

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published