Skip to content

Commit ffe7428

Browse files
angelonazzaroangelonazzaro
authored
typxidian:1.0.0 (#3716)
1 parent e7ae772 commit ffe7428

File tree

21 files changed

+1699
-0
lines changed

21 files changed

+1699
-0
lines changed

‎packages/preview/typxidian/1.0.0/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/1.0.0/README.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# TypXidian
2+
3+
**TypXidian** is a highly customizable template for academic writing, thought for theses, disserations and reports.
4+
It is based, both on color palette and functionalities, on [Obsidian](https://obsidian.md/)
5+
and "Alice in a Differentiable Wonderland" by Simone Scardapane
6+
7+
A twin LaTeX version of TypXidian is available at: [LaXidiaN](https://github.com/robertodr01/LaXidiaN).
8+
## Features
9+
10+
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.
11+
12+
Citations, references and links are configurable with custom colors.
13+
14+
To improve readability, TypXidian includes styled environments for notes, tips, and warnings. These callouts are inspired by [Obsidian](https://obsidian.md/).
15+
Mathematical writing is also supported, with environments for definitions, theorems, and proofs.
16+
17+
<table align="center">
18+
<tr>
19+
<td>
20+
<img src="https://github.com/user-attachments/assets/760fa379-bbae-4159-a181-63e9970224bf" width="350px">
21+
</td>
22+
<td>
23+
<img src="https://github.com/user-attachments/assets/c0023792-3e94-4b3e-82cf-13332423bd79" width="500px">
24+
</td>
25+
</tr>
26+
<tr>
27+
<td>Callouts</td>
28+
<td>Math environments</td>
29+
</tr>
30+
</table>
31+
32+
Finally, the template allows you to select fonts, paper sizes, and languages so that the document feels tailored to your academic context.
33+
34+
## Usage
35+
36+
To use TypXidian, start a new `.typ` document and import the template.
37+
To use the template locally, run the following command in your terminal:
38+
```bash
39+
typst init @preview/typxidian:1.0.0
40+
```
41+
42+
Here is a minimal example showing how to set up the template with metadata for a thesis:
43+
44+
```typst
45+
#import "@preview/typxidian:1.0.0": *
46+
47+
#show: template.with(
48+
title: [TypXidian],
49+
subtitle: [A template for academic writing written in Typst],
50+
department: [Department of Computer Science],
51+
course: [Master of Science (Computer Science)],
52+
university: [University of Salerno],
53+
academic-year: [2024-2025],
54+
authors: ((name: "Mario Rossi", email: "mario@rossi.it", num: "Registration Number: XXXX"),),
55+
supervisors: ("Prof. Giuseppe Verdi", "Prof. Mario Bianchi"),
56+
is-thesis: true,
57+
thesis-type: [master thesis],
58+
abbreviations: abbreviations,
59+
chapter-alignment: right,
60+
bib: bibliography("bibliography.bib"),
61+
quote: quote(block: true, quotes: true, attribution: [Some wise guy], [#lorem(25)]),
62+
abstract: lorem(200),
63+
)
64+
```
65+
66+
Once the metadata is in place, you can start writing your chapters and sections immediately below.
67+
The template will handle the layout of the title page, abstract, and other structural elements automatically.
68+
69+
## Working with Chapters
70+
71+
Typst does not currently support _textual inclusion_, meaning that you can use only dependencies directly imported in the current file. For this reason, if you plan to split your document into standalone chapters, you must include the package in each file to access its functions.
72+
73+
74+
## Requirements
75+
76+
To work with TypXidian you will need:
77+
78+
- [Typst](https://typst.app/) version 0.13.1 or newer
79+
- Optionally, a `.bib` file if you want to manage your bibliography
80+
- Optionally, an `abbreviations.typ` file if your document uses acronyms
81+
- The template also makes use of Font Awesome icons via the [fontawesome](https://typst.app/universe/package/fontawesome) package.
82+
For these to display correctly, you should install the [Font Awesome 7 Desktop](https://fontawesome.com/download) fonts on your computer,
83+
or upload them to your project folder if you are working on the Typst web app.
84+
85+
## License
86+
87+
TypXidian is distributed under the MIT License.
88+
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).

‎packages/preview/typxidian/1.0.0/src/.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.DS_Store
2+
*.pdf
3+
*.ttf
4+
*.otf

0 commit comments

Comments
 (0)