Skip to content

Commit 27fb9ee

Browse files
angelonazzaroangelonazzaro
authored
typxidian:0.1.2 (typst#3152)
1 parent 8ed9913 commit 27fb9ee

File tree

16 files changed

+1451
-0
lines changed

16 files changed

+1451
-0
lines changed

‎packages/preview/typxidian/0.1.2/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Angelo Nazzaro
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎packages/preview/typxidian/0.1.2/README.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# TypXidian
2+
3+
**TypXidian** is a Typst template for academic documents, such as theses, dissertations, and reports.
4+
5+
## Features
6+
7+
The template comes with a structured title page that can include a wide range of academic metadata: title, subtitle, authors, supervisors, university, faculty, department, degree, academic year, a quote and an abstract.
8+
9+
Citations, references and links are configurable with custom colors.
10+
11+
To improve readability, TypXidian includes styled environments for notes, tips, and warnings. These callouts are inspired by [Obsidian](https://obsidian.md/).
12+
Mathematical writing is also supported, with environments for definitions, theorems, and proofs.
13+
14+
<table align="center">
15+
<tr>
16+
<td>
17+
<img src="https://github.com/user-attachments/assets/760fa379-bbae-4159-a181-63e9970224bf" width="350px">
18+
</td>
19+
<td>
20+
<img src="https://github.com/user-attachments/assets/c0023792-3e94-4b3e-82cf-13332423bd79" width="500px">
21+
</td>
22+
</tr>
23+
<tr>
24+
<td>Callouts</td>
25+
<td>Math environments</td>
26+
</tr>
27+
</table>
28+
29+
Finally, the template allows you to select fonts, paper sizes, and languages so that the document feels tailored to your academic context.
30+
31+
## Usage
32+
33+
To use TypXidian, start a new `.typ` document and import the template.
34+
To use the template locally, run the following command in your terminal:
35+
```bash
36+
typst init @preview/typxidian:0.1.2
37+
```
38+
39+
Here is a minimal example showing how to set up the template with metadata for a thesis:
40+
41+
```typst
42+
#import "@preview/typxidian:0.1.2": *
43+
44+
#show: template.with(
45+
title: [TypXidian],
46+
authors: ("Giuseppe Verdi", ),
47+
supervisors: ("Prof. Mario Rossi", "Prof. Mario Bianchi"),
48+
subtitle: [A template for academic documents written in Typst],
49+
university: [University of Salerno],
50+
faculty: [Faculty of Science],
51+
degree: [Master's Degree in Machine Learning & Data Science],
52+
department: [Department of Computer Science],
53+
academic-year: [2025/2026],
54+
abstract: lorem(150),
55+
quote: [
56+
#lorem(20)
57+
\ \ #align(right, [-- John Doe])
58+
],
59+
bib: bibliography("bibliography.bib"),
60+
abbreviations: abbreviations,
61+
)
62+
```
63+
64+
Once the metadata is in place, you can start writing your chapters and sections immediately below.
65+
The template will handle the layout of the title page, abstract, and other structural elements automatically.
66+
67+
### Working with Chapters
68+
69+
Typst does not currently support textual inclusion. If you plan to split your document into standalone chapter files, you can simply re-include the package in each file to access its functions
70+
71+
## Requirements
72+
73+
To work with TypXidian you will need:
74+
75+
- [Typst](https://typst.app/) version 0.13.1 or newer
76+
- Optionally, a `.bib` file if you want to manage your bibliography
77+
- Optionally, an `abbreviations.typ` file if your document uses acronyms
78+
- The template also makes use of Font Awesome icons via the [fontawesome](https://typst.app/universe/package/fontawesome) package.
79+
For these to display correctly, you should install the [Font Awesome 7 Desktop](https://fontawesome.com/download) fonts on your computer,
80+
or upload them to your project folder if you are working on the Typst web app.
81+
82+
## License
83+
84+
TypXidian is distributed under the MIT License.
85+
Please note that the cat and dog photographs included in the example document (`main.typ`) are licensed under the [Unsplash terms](https://unsplash.com/license).

0 commit comments

Comments
 (0)