|
1 | | -# The `my-package` Package |
2 | | -<div align="center">Version 0.1.0</div> |
3 | | - |
4 | | -A short description about the project and/or client. |
5 | | - |
6 | | -## Template adaptation checklist |
7 | | - |
8 | | -- [ ] Fill out `README.md` |
9 | | - - Change the `my-package` package name, including code snippets |
10 | | - - Check section contents and/or delete sections that don't apply |
11 | | -- [ ] Check and/or replace `LICENSE` by something that suits your needs |
12 | | -- [ ] Fill out `typst.toml` |
13 | | - - See also the [typst/packages README](https://github.com/typst/packages/?tab=readme-ov-file#package-format) |
14 | | -- [ ] Adapt Repository URLs in `CHANGELOG.md` |
15 | | - - Consider only committing that file with your first release, or removing the "Initial Release" part in the beginning |
16 | | -- [ ] Adapt or deactivate the release workflow in `.github/workflows/release.yml` |
17 | | - - to deactivate it, delete that file or remove/comment out lines 2-4 (`on:` and following) |
18 | | - - to use the workflow |
19 | | - - [ ] check the values under `env:`, particularly `REGISTRY_REPO` |
20 | | - - [ ] if you don't have one, [create a fine-grained personal access token](https://github.com/settings/tokens?type=beta) with [only Contents permission](https://stackoverflow.com/a/75116350/371191) for the `REGISTRY_REPO` |
21 | | - - [ ] on this repo, create a secret `REGISTRY_TOKEN` (at `https://github.com/[user]/[repo]/settings/secrets/actions`) that contains the so created token |
22 | | - |
23 | | - 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](https://github.com/typst/packages/) |
24 | | -- [ ] remove/replace the example test case |
25 | | -- [ ] (add your actual code, docs and tests) |
26 | | -- [ ] remove this section from the README |
27 | | - |
28 | | -## Getting Started |
29 | | - |
30 | | -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. |
31 | | - |
32 | | -```typ |
33 | | -#import "@preview/my-package:0.1.0": * |
34 | | -
|
35 | | -#show: my-show-rule.with() |
36 | | -#my-func() |
37 | | -``` |
38 | | - |
39 | | -<picture> |
40 | | - <source media="(prefers-color-scheme: dark)" srcset="./thumbnail-dark.svg"> |
41 | | - <img src="./thumbnail-light.svg"> |
42 | | -</picture> |
43 | | - |
44 | | -### Installation |
45 | | - |
46 | | -A step by step guide that will tell you how to get the development environment up and running. This should explain 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. |
47 | | - |
48 | | -``` |
49 | | -$ First step |
50 | | -$ Another step |
51 | | -$ Final step |
52 | | -``` |
53 | | - |
54 | | -## Usage |
55 | | - |
56 | | -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. |
57 | | - |
58 | | -```typ |
59 | | -#import "@preview/my-package:0.1.0": * |
60 | | -
|
61 | | -#let my-complicated-example = ... |
62 | | -``` |
63 | | - |
64 | | -## Additional Documentation and Acknowledgments |
65 | | - |
66 | | -* Project folder on server: |
67 | | -* Confluence link: |
68 | | -* Asana board: |
69 | | -* etc... |
| 1 | +# Jsume (JSON Resume) Typst Template |
0 commit comments