Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions packages/preview/glossy/0.9.1/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025, 2026 Stephen Waits <steve@waits.net>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
439 changes: 439 additions & 0 deletions packages/preview/glossy/0.9.1/README.md

Large diffs are not rendered by default.

55 changes: 55 additions & 0 deletions packages/preview/glossy/0.9.1/README_development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Testing


Links

* [Devcontainer](https://containers.dev/)
* [Devcontainer in VSCode (Visual Studio Code)](https://code.visualstudio.com/docs/devcontainers/containers)
* [GitHub Codespaces](https://github.com/features/codespaces)

Folders

* `tests`: Folder with tests
* `bin/autotest.sh`: Script which runs all tests
* Tytanic: https://github.com/typst-community/tytanic

## Running the tests manually

```bash
just check
```

### Test environment: Devcontainer in VSCode

Clone this repo and open VSCode

`glossy.code-workspace`

VSCode will ask you if you would like to start the devcontainer: Yes

Wait for a few minutes until you see `*** Container build successfully ***`

Open a terminal and type

```bash
$ typst --version
typst <installed version>
$ tt --version
tytanic <installed version>
$ tt list
$ tt run --no-fail-fast
```

### Test environment: Devcontainer in a GitHub Codespace

Browser: Open https://github.com/swaits-typst-packages/glossy
Click `Code` -> `Codespaces` -> `Create codespace on` and select the branch you want to test.

Wait for a few minutes until you see `*** Container build successfully ***`

Open a terminal and type as above.

## Testrunner and CI pipelines

* Testrunner: https://github.com/typst-community/tytanic
* Repo using the testrunner in a ci pipeline: https://github.com/janekfleper/typst-fancy-units/blob/main/.github/workflows/ci.yaml
76 changes: 76 additions & 0 deletions packages/preview/glossy/0.9.1/README_publish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Publish changes

## Links

* repository to publish to: https://github.com/typst/packages/tree/main/packages/preview/glossy

* doc: https://github.com/typst/packages/blob/main/docs/README.md
* doc: https://github.com/typst/packages/blob/main/docs/tips.md#what-to-commit-what-to-exclude

Example PR from glossy:

- [v0.9.0](https://github.com/typst/packages/pull/3323)
- [v0.8.0](https://github.com/typst/packages/pull/2122)

## Prepare to publish

**There is a branch `submitted-upstream`: It will no longer be used for publishing.**

1. Make these commands run without error

```bash
just fmt # format all .typ files in place
just check # fmt-check + full test suite
```

2. Update changelog in `README.md`

3. Update version in `typst.toml`

```bash
just bump patch # or minor
```

4. Run full pre-submission checks

```bash
just pre-submit # clean → images → check
```

5. Commit to `main` and create a version tag.

```bash
git tag -a vx.y.z -m "x.y.z"
git push && git push --tags
```

6. Create a fork of https://github.com/typst/packages/

7. Copy package files into a local clone of the upstream registry.

```bash
cd ~/src/glossy
TYPST_PACKAGES_REPO=~/typst-packages

ver=$(grep '^version' "typst.toml" | cut -d'"' -f2)
dest="$TYPST_PACKAGES_REPO/packages/preview/glossy/$ver"

rm -r "$dest"
mkdir -p "$dest"
cp -r src "$dest/"
cp -r justfile lib.typ LICENSE README.md README_publish.md README_development.md typst.toml themeshots.png thumbnail.png "$dest/"
```

8. On fork of https://github.com/typst/packages/

```bash
cd $TYPST_PACKAGES_REPO
git switch -c submit_glossy
git add packages/preview/glossy/$ver
git commit -m "glossy:$ver"
git push -u origin submit_glossy
```

## Notes on just

Run `just` (or `just help`) to list all available recipes.
2 changes: 2 additions & 0 deletions packages/preview/glossy/0.9.1/lib.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#import "src/gloss.typ": glossary, init-glossary
#import "src/themes.typ": *
Loading
Loading