diff --git a/.typstignore b/.typstignore new file mode 100644 index 0000000..18fc8ca --- /dev/null +++ b/.typstignore @@ -0,0 +1,18 @@ +# this is not a "standard" ignore file, it's specific to this template's `scripts/package` script +# list any files here that should not be uploaded to Universe when releasing this package + +# if you are used to ignore files, be aware that .typstignore is a bit more limited: +# - only this file is used; .typstignore files in subdirectories are not considered +# - patterns must match file/directory names from the beginning: `x.typ` will not match `src/x.typ` +# - `*` in patterns works, but also matches directory separators: `*.typ` _will_ match `src/x.typ` +# .git and .typstignore are excluded automatically + +.github +scripts +tests +Justfile +examples +CONTRIBUTING.md +# PDF manuals should be included so that they can be linked, but not their sources +docs/* +!docs/*.pdf diff --git a/README.md b/README.md index 1e2b085..6bc0ecd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # solo-lu-df A Typst template to write qualification papers, bachelor’s theses, and master’s -theses for Latvijas Universitāte (Faculty of Exact Sciences, Computer Science). +theses for Latvijas Universitāte (Faculty of Science and Technology). The package provides university-compliant layout rules, helpers for title/abstract/attachments, and a ready-to-edit example. @@ -67,13 +67,22 @@ template, you can add a show rule like this at the top of your file: columns: (1fr, 1fr), [Column 1], [Column 2], ), - ), - ), +), ) // Your content goes below. ``` +## Examples + +A ready-to-edit qualification thesis example is included in the repository: + +View the example on GitHub: + +The example contains `main.typ`, `bibliography.yml` and small helpers under + ), +`utils/`. Use it as a starting point or copy it into a new project. + ## Tips - Install the fonts used by the template (Times family, JetBrains Mono) to diff --git a/src/lib.typ b/src/lib.typ index 78c0171..7e557bb 100644 --- a/src/lib.typ +++ b/src/lib.typ @@ -28,14 +28,14 @@ keyword-title: "Atslēgvārdi", lang: "lv", text: [], - keywords: [], + keywords: (), ), secondary: ( title: "Abstract", keyword-title: "Keywords", lang: "en", text: [], - keywords: [], + keywords: (), ), ), // The result of a call to the `bibliography` function or `none`. diff --git a/typst.toml b/typst.toml index 2cfc1d9..37cd6e5 100644 --- a/typst.toml +++ b/typst.toml @@ -1,12 +1,11 @@ [package] name = "solo-lu-df" version = "0.1.0" -compiler = "0.13.0" entrypoint = "src/lib.typ" -repository = "https://github.com/kristoferssolo/LU-DF-Typst-Template" authors = ["Kristofers Solo "] license = "MIT" description = "Write qualification papers, bachelor’s theses, and master’s theses for University of Lativa, Computer Science programme." +repository = "https://github.com/kristoferssolo/LU-DF-Typst-Template" keywords = [ "University of Latvia", "LU", @@ -17,16 +16,8 @@ keywords = [ ] categories = ["paper"] disciplines = ["computer-science"] -exclude = [ - ".github", - "docs", - "scripts", - "examples", - "tests", - ".typstignore", - "Justfile", - "thumbnail.png", -] +compiler = "0.13.0" +exclude = [] [template] path = "template"