-
Notifications
You must be signed in to change notification settings - Fork 718
dmi-basilea-thesis:0.1.2 #3115
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Nifalu
wants to merge
2
commits into
typst:main
Choose a base branch
from
Nifalu:dmi-basilea-thesis-0.1.2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
dmi-basilea-thesis:0.1.2 #3115
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) [2025] [Nico Bachmann] | ||
|
||
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,171 @@ | ||
# DMI Basel Thesis Template for Typst | ||
|
||
A modern thesis template for the University of Basel, Department of Mathematics | ||
and Computer Science, built with [Typst](https://typst.app). | ||
|
||
## Features | ||
|
||
- **Fast compilation**: Near-instant preview updates | ||
- **Clean design**: Based on the official LaTeX template | ||
- **Multi-language**: Supports English and German | ||
- **Draft mode**: Built-in TODO markers and draft indicators | ||
- **Rich formatting**: Custom environments for definitions, theorems, algorithms | ||
- **Flexible typography**: Full control over fonts, sizes, and weights | ||
|
||
## Quick Start | ||
|
||
### Using the Typst Package | ||
|
||
```typst | ||
#import "@preview/dmi-basilea-thesis:0.1.2": * | ||
|
||
#show: thesis.with( | ||
title: "Your Thesis Title", | ||
author: "Your Name", | ||
supervisor: "Prof. Dr. Supervisor", | ||
examiner: "Prof. Dr. Examiner", | ||
thesis-type: "Bachelor Thesis", // or "Master Thesis" | ||
|
||
abstract: [ | ||
Your abstract here... | ||
], | ||
|
||
chapters: ( | ||
include "introduction.typ", | ||
include "methodology.typ", | ||
include "conclusion.typ", | ||
), | ||
|
||
bibliography-content: bibliography("references.bib"), | ||
) | ||
``` | ||
|
||
### Local Development | ||
|
||
1. Clone this repository | ||
2. Import from the local path: | ||
```typst | ||
#import "src/main.typ": * | ||
``` | ||
|
||
## Configuration Options | ||
|
||
### Basic Settings | ||
|
||
- `title`: Your thesis title | ||
- `author`: Your name | ||
- `email`: Your email address | ||
- `supervisor`: Name of your supervisor | ||
- `examiner`: Name of your examiner | ||
- `thesis-type`: "Bachelor Thesis" or "Master Thesis" | ||
- `language`: "en" or "de" | ||
- `date`: Defaults to today | ||
|
||
### Optional Typography Control | ||
|
||
#### Font Families | ||
|
||
- `body-font`: Main text font (default: "Times New Roman") | ||
- `sans-font`: Headings font (default: "Arial") | ||
- `mono-font`: Code font (default: "Courier New") | ||
|
||
#### Font Sizes | ||
|
||
- `body-size`: Main text size (default: 10pt) | ||
- `mono-size`: Code text size (default: 10pt) | ||
- `footnote-size`: Footnote size (default: 9pt) | ||
- `header-size`: Page header size (default: 9pt) | ||
|
||
#### Heading Sizes | ||
|
||
- `chapter-number-size`: Chapter number size (default: 100pt) | ||
- `chapter-title-size`: Chapter title size (default: 24pt) | ||
|
||
#### Font Weights | ||
|
||
- `chapter-number-weight`: Weight for chapter numbers (default: "bold") | ||
- `chapter-title-weight`: Weight for chapter titles (default: "bold") | ||
|
||
#### Sections | ||
|
||
- `sections`: This is an array where each object defines the styling for a | ||
specific subsection level. The array index corresponds to the subsection level | ||
(e.g., index 0 for level 1, index 1 for level 2, and so on). Each object | ||
within the array contains the following properties: | ||
- `size`: The font size of the section | ||
- `weight`: The font weight | ||
- `space-before`: The spacing before the section start | ||
- `space-after`: The spacing after the section title | ||
- `style`: A custom styling function for the section | ||
- `default-section`: This is a single dictionary that defines the default | ||
styling for any heading level not explicitly included in the sections array. | ||
It contains the same properties as the dictionaries within the sections array. | ||
|
||
### Advanced Styling | ||
|
||
For complete control, you can provide custom styling functions: | ||
|
||
```typst | ||
#show: thesis.with( | ||
// Rainbow gradient chapter titles | ||
chapter-title-style: (content) => text( | ||
size: 30pt, | ||
fill: gradient.linear(..color.map.rainbow), | ||
content | ||
), | ||
|
||
// Custom body text | ||
body-text-style: (body) => { | ||
set text(font: "Minion Pro", size: 11pt) | ||
body | ||
}, | ||
) | ||
``` | ||
|
||
Available style functions: | ||
|
||
- `body-text-style`: Override body text styling | ||
- `mono-text-style`: Override code text styling | ||
- `chapter-number-style`: Override chapter number styling | ||
- `chapter-title-style`: Override chapter title styling | ||
|
||
### Compilation Modes | ||
|
||
- `draft`: Show/hide TODO markers (default: true) | ||
- `colored`: Enable/disable colors for definitions and theorems (default: false) | ||
|
||
## Template Features | ||
|
||
### TODO Markers (Draft Mode) | ||
|
||
```typst | ||
#todo[General TODO] | ||
#todo-missing[Missing content] | ||
#todo-check[Needs verification] | ||
#todo-revise[Needs revision] | ||
#todo-citation[Add citation] | ||
#todo-language[Check language] | ||
#todo-question[Open question] | ||
#todo-note[Note to self] | ||
``` | ||
|
||
### Custom Environments | ||
|
||
```typst | ||
#definition(title: "Definition")[ | ||
Your definition here... | ||
] | ||
|
||
#theorem(title: "Theorem")[ | ||
Your theorem here... | ||
] | ||
|
||
#algorithm(caption: "My Algorithm")[ | ||
Your algorithm here... | ||
] | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! Please open an issue or submit a pull request on | ||
[GitHub](https://github.com/Nifalu/dmi-basilea-thesis). |
Binary file not shown.
Binary file not shown.
15 changes: 15 additions & 0 deletions
15
packages/preview/dmi-basilea-thesis/0.1.2/src/assets/logo-de.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To make the manual easier to discover, can you link to it in your README, please?