Skip to content

Commit

Permalink
Merge branch 'main' into link-color
Browse files Browse the repository at this point in the history
  • Loading branch information
sebaseb98 committed Nov 20, 2024
2 parents 4fda2ce + 4187d60 commit 1cf8ad0
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 14 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[Typst](https://typst.app/home/) thesis template for mathematical theses built for simple, efficient use and a clean look.
Of course, it can also be used for other subjects, but the following math-specific features are already contained in the template:

- theorems, lemmas, corollaries, proofs etc. prepared using [great-theorems](https://typst.app/universe/package/great-theorems)
- theorems, lemmas, corollaries, proofs etc. prepared using [great-theorems](https://typst.app/universe/package/great-theorems)
- equation settings (optionally using [equate](https://typst.app/universe/package/equate))
- pseudocode package [lovelace](https://typst.app/universe/package/lovelace) included.

Expand All @@ -24,7 +24,7 @@ typst init @preview/clean-math-thesis:0.2.0

- edit the data in `main.typ``#show template.with([your data])`

#### Parameters of the Template
### Parameters of the Template
<ins>personal/subject related information</ins>
- `author`: Name of the author of the thesis.
- `title`: Title of the thesis.
Expand All @@ -38,25 +38,27 @@ typst init @preview/clean-math-thesis:0.2.0

<ins>file paths for logos etc.</ins>
- `uni-logo`: Image, e.g. `image("images/logo_placeholder.svg", width: 50%)`
- `institute-logo`: Image.
- `institute-logo`: Image.

<ins>formatting settings</ins>
- `citation-style`: Citation style to be used in the thesis.
- `body-font`: Font to be used for the body text.
- `cover-font`: Font to be used for the cover text.
- `cover-font`: Font to be used for the cover text.

<ins>content that needs to be placed differently then normal chapters</ins>
- `abstract`: Content for the abstract section.
- `abstract`: Content for the abstract section.

<ins>equation settings</ins>
- `equate-settings`: either none -> no equate use; or tuple with the settings for the equations (see [docs](https://typst.app/universe/package/equate)), e.g. (breakable: true, sub-numbering: true, number-mode: "label")
- `numbering-pattern`: specify the [numbering](https://typst.app/docs/reference/model/numbering/#parameters-numbering) of the equations. The second counting symbol (e.g. the `a` in `"(1.a)"`) is only used when equate and subnumbering are activated, otherwise it's ignored

<ins>colors</ins>
- `colors`: Color scheme to be used in the thesis. has to be formatted like `(cover-color: rgb("#800080"), heading-color: rgb("#0000ff"))`
- `cover-color`: Color used for the cover.
- `heading-color`: Color used for headings.
- `link-color`: Color used for links and references.


#### Other Customizations
### Other Customizations
- `declaration.typ` should be modified
- when adding chapters, remember to include them into the `main.typ`.
- (optional) change colors and appearance of the theorem environment in the `customization/`-folder.
Expand All @@ -75,12 +77,12 @@ If you want to change an existing typst project structure to use this template,
```


### Disclaimer
This template was created after Sebastian finished his master's thesis.
## Disclaimer
This template was created after Sebastian finished his master's thesis.
We do not guarantee that it will be accepted by any university, please clarify in advance if it fulfills all requirements. If not, this template might still be a good starting point.

### Acknowledgements
As inspiration on how to structure this template, We used the [modern-unito-thesis](https://typst.app/universe/package/modern-unito-thesis) template. The design is inspired by the [fau-book](https://github.com/FAU-AMMN/fau-book) template.
## Acknowledgements
As inspiration on how to structure this template, we used the [modern-unito-thesis](https://typst.app/universe/package/modern-unito-thesis) template. The design is inspired by the [fau-book](https://github.com/FAU-AMMN/fau-book) template.

### Feedback & Improvements
## Feedback & Improvements
If you encounter problems, please open issues. In case you found useful extensions or improved anything We are also very happy to accept pull requests.
4 changes: 3 additions & 1 deletion lib.typ
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
abstract: none,

// colors
cover-color: rgb("#800080"),
cover-color: rgb("#800080"),
heading-color: rgb("#0000ff"),
link-color: rgb("#000000"),

Expand All @@ -45,6 +45,8 @@
// ------------------- settings -------------------
set heading(numbering: "1.1") // Heading numbering
set enum(numbering: "(i)") // Enumerated lists
show link: set text(fill: link-color)
show ref: set text(fill: link-color)

// ------------------- Math equation settings -------------------

Expand Down
Binary file modified template/main.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion template/main.typ
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
// colors
cover-color: color1,
heading-color: color2,
link-color: color3,
link-color: color3
)
// ------------------- content -------------------
#include "chapter/introduction.typ"
Expand Down

0 comments on commit 1cf8ad0

Please sign in to comment.