Skip to content

Commit a82c93c

Browse files
mayconfmelomayconfmelo
authored
min-book:1.0.0 (typst#2430)
1 parent ff1b776 commit a82c93c

File tree

10 files changed

+2000
-0
lines changed

10 files changed

+2000
-0
lines changed

‎packages/preview/min-book/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 Maycon F. Melo
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/min-book/1.0.0/README.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Minimal Books
2+
3+
<center>
4+
Simple and complete books without introducing new syntax
5+
</center>
6+
7+
8+
## Quick Start
9+
10+
```typst
11+
#import "@preview/min-book:1.0.0": book
12+
#show: book.with(
13+
title: "Book Title",
14+
subtitle: "Complementary subtitle, not more than two lines long",
15+
authors: "Author",
16+
)
17+
```
18+
19+
20+
## Description
21+
22+
Generate complete and complex books, without any annoying new commands or syntax,
23+
just good old pure Typst. This package works by manipulating the standard Typst
24+
elements, adapting them to the needs of a book structure. All of this is managed
25+
behind the scenes, so that nothing changes in the Typst code itself.
26+
27+
The commands that `min-book` provides are only included for the sake of
28+
completeness, and offers some fancy optional features like horizontal rules or
29+
end notes; but it's perfectly possible to write entire books without them.
30+
31+
32+
## More Information
33+
34+
- [Official manual](https://raw.githubusercontent.com/mayconfmelo/min-book/refs/tags/1.0.0/docs/manual.pdf)
35+
- [Example PDF result](https://raw.githubusercontent.com/mayconfmelo/min-book/refs/tags/1.0.0/docs/example.pdf)
36+
- [Example Typst code](https://github.com/mayconfmelo/min-book/blob/1.0.0/template/main.typ)
37+
- [Changelog](https://github.com/mayconfmelo/min-book/blob/main/CHANGELOG.md)
38+
39+
40+
## Default Fonts
41+
42+
<table>
43+
<tr>
44+
<td>Text:</td>
45+
<td>Book Antiqua, or<br/>Times New Roman</td>
46+
</tr>
47+
<tr>
48+
<td>Math:</td>
49+
<td><a href="https://mirrors.ctan.org/fonts/Asana-Math/Asana-Math.otf">
50+
Asana Math
51+
</a></td>
52+
</tr>
53+
<tr>
54+
<td>Mono:</td>
55+
<td><a href="https://fonts.google.com/specimen/Inconsolata">
56+
Inconsolata
57+
</a></td>
58+
</tr>
59+
<tr>
60+
<td>Cover title:</td>
61+
<td><a href="https://fonts.google.com/specimen/Cinzel">Cinzel</a></td>
62+
</tr>
63+
<tr>
64+
<td>Cover text:</td>
65+
<td><a href="https://fonts.google.com/specimen/Alice">Alice</a></td>
66+
</tr>
67+
</table>
68+
69+
70+
## Full List of Features
71+
72+
- Cover
73+
- Automatic generation
74+
- Creation using Typst
75+
- Using existing `#image`
76+
- Title page
77+
- Automatic generation
78+
- Creation using Typst
79+
- Cataloging in Publication
80+
- Errata
81+
- Dedication
82+
- Acknowledgments
83+
- Epigraph
84+
- Table of contents
85+
- Multi-language support
86+
- Accessible default fonts
87+
- Book parts (headings)
88+
- Book chapters (headings)
89+
- End Notes
90+
- Horizontal Rule
91+
- Block Quote
92+
- Appendices ambient
93+
- Annexes ambient

‎packages/preview/min-book/1.0.0/src/assets/frame-gray.svg‎

Lines changed: 52 additions & 0 deletions
Loading

‎packages/preview/min-book/1.0.0/src/assets/frame.svg‎

Lines changed: 52 additions & 0 deletions
Loading

‎packages/preview/min-book/1.0.0/src/assets/lang.toml‎

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
[conf]
2+
default-lang = "en"
3+
4+
[lang.en]
5+
volume = [ "Volume", "vol."]
6+
edition = [ "Edition", "ed."]
7+
part = "Part"
8+
chapter = "Chapter"
9+
appendix = [ "Appendix", "Appendices" ]
10+
annex = [ "Annex", "Annexes" ]
11+
errata = "Errata"
12+
acknowledgements = "Acknowledgements"
13+
14+
[lang.pt]
15+
volume = [ "Volume", "vol."]
16+
edition = [ "Edição", "ed."]
17+
part = "Parte"
18+
chapter = "Capítulo"
19+
appendix = [ "Apêndice", "Apêndices" ]
20+
annex = [ "Anexo", "Anexos" ]
21+
errata = "Errata"
22+
acknowledgements = "Agradecimentos"
23+
24+
25+
# The following are AI translations, and may contain errors:
26+
27+
[lang.es]
28+
volume = [ "Volumen", "vol." ]
29+
edition = [ "Edición", "ed." ]
30+
part = "Parte"
31+
chapter = "Capítulo"
32+
appendix = [ "Apéndice", "Apéndices" ]
33+
annex = [ "Anexo", "Anexos" ]
34+
errata = "Fe de erratas"
35+
acknowledgements = "Agradecimientos"
36+
37+
[lang.fr]
38+
volume = [ "Volume", "vol." ]
39+
edition = [ "Édition", "éd." ]
40+
part = "Partie"
41+
chapter = "Chapitre"
42+
appendix = [ "Annexe", "Annexes" ]
43+
annex = [ "Appendice", "Appendices" ]
44+
errata = "Errata"
45+
acknowledgements = "Remerciements"
46+
47+
[lang.de]
48+
volume = [ "Band", "Bd." ]
49+
edition = [ "Ausgabe", "Ausg." ]
50+
part = "Teil"
51+
chapter = "Kapitel"
52+
appendix = [ "Anhang", "Anhänge" ]
53+
annex = [ "Anlage", "Anlagen" ]
54+
errata = "Errata"
55+
acknowledgements = "Danksagungen"
56+
57+
[lang.id]
58+
volume = [ "Jilid", "jld." ]
59+
edition = [ "Edisi", "ed." ]
60+
part = "Bagian"
61+
chapter = "Bab"
62+
appendix = [ "Lampiran", "Lampiran" ]
63+
annex = [ "Aneks", "Aneks" ]
64+
errata = "Koreksi"
65+
acknowledgements = "Ucapan Terima Kasih"
66+
67+
[lang.it]
68+
volume = [ "Volume", "vol." ]
69+
edition = [ "Edizione", "ed." ]
70+
part = "Parte"
71+
chapter = "Capitolo"
72+
appendix = [ "Appendice", "Appendici" ]
73+
annex = [ "Allegato", "Allegati" ]
74+
errata = "Errata"
75+
acknowledgements = "Ringraziamenti"
76+
77+
[lang.tr]
78+
volume = [ "Cilt", "c." ]
79+
edition = [ "Baskı", "bs." ]
80+
part = "Bölüm"
81+
chapter = "Bap"
82+
appendix = [ "Ek", "Ekler" ]
83+
annex = [ "İlave", "İlaveler" ]
84+
errata = "Düzeltmeler"
85+
acknowledgements = "Teşekkürler"
86+
87+
[lang.vi]
88+
volume = [ "Tập", "t." ]
89+
edition = [ "Ấn bản", "ab." ]
90+
part = "Phần"
91+
chapter = "Chương"
92+
appendix = [ "Phụ lục", "Phụ lục" ]
93+
annex = [ "Phụ đính", "Phụ đính" ]
94+
errata = "Sửa lỗi"
95+
acknowledgements = "Lời cảm ơn"
96+
97+
[lang.pl]
98+
volume = [ "Tom", "t." ]
99+
edition = [ "Wydanie", "wyd." ]
100+
part = "Część"
101+
chapter = "Rozdział"
102+
appendix = [ "Dodatek", "Dodatki" ]
103+
annex = [ "Załącznik", "Załączniki" ]
104+
errata = "Errata"
105+
acknowledgements = "Podziękowania"
106+
107+
[lang.ro]
108+
volume = [ "Volum", "vol." ]
109+
edition = [ "Ediție", "ed." ]
110+
part = "Partea"
111+
chapter = "Capitolul"
112+
appendix = [ "Anexă", "Anexe" ]
113+
annex = [ "Apéndice", "Apéndicele" ]
114+
errata = "Erata"
115+
acknowledgements = "Mulțumiri"
116+
117+
[lang.nl]
118+
volume = [ "Deel", "dl." ]
119+
edition = [ "Editie", "ed." ]
120+
part = "Deel"
121+
chapter = "Hoofdstuk"
122+
appendix = [ "Bijlage", "Bijlagen" ]
123+
annex = [ "Aanhangsel", "Aanhangsels" ]
124+
errata = "Errata"
125+
acknowledgements = "Woord van dank"
126+
127+
[lang.jv]
128+
volume = [ "Jilid", "jld." ]
129+
edition = [ "Édisi", "ed." ]
130+
part = "Bagean"
131+
chapter = "Bab"
132+
appendix = [ "Llampiran", "Llampiran" ]
133+
annex = [ "Llampahan", "Llampahan" ]
134+
errata = "Ralat"
135+
acknowledgements = "Pangatur pambagyaharja"
136+
137+
[lang.fil]
138+
volume = [ "Tomo", "tom." ]
139+
edition = [ "Edisyon", "eds." ]
140+
part = "Bahagi"
141+
chapter = "Kabanata"
142+
appendix = [ "Apendiks", "Mga Apendiks" ]
143+
annex = [ "Ankla", "Mga Ankla" ]
144+
errata = "Pagwawasto"
145+
acknowledgements = "Pasasalamat"
146+
147+
[lang.ha]
148+
volume = [ "Juzu'i", "jz." ]
149+
edition = [ "Bugu", "bg." ]
150+
part = "Sashe"
151+
chapter = "Babi"
152+
appendix = [ "Ƙari", "Ƙarori" ]
153+
annex = [ "Ƙari na biyu", "Ƙarori na biyu" ]
154+
errata = "Gyara"
155+
acknowledgements = "Godiya"
156+
157+
[lang.sw]
158+
volume = [ "Juzuu", "jz." ]
159+
edition = [ "Toleo", "tl." ]
160+
part = "Sehemu"
161+
chapter = "Sura"
162+
appendix = [ "Kiambatisho", "Viambatisho" ]
163+
annex = [ "Kiambatanisho", "Viambatanisho" ]
164+
errata = "Marekebisho"
165+
acknowledgements = "Shukrani"
166+
167+
[lang.uk]
168+
volume = [ "Том", "т." ]
169+
edition = [ "Видання", "вид." ]
170+
part = "Частина"
171+
chapter = "Розділ"
172+
appendix = [ "Додаток", "Додатки" ]
173+
annex = [ "Додаткова частина", "Додаткові частини" ]
174+
errata = "Виправлення"
175+
acknowledgements = "Подяки"
176+
177+
[lang.uz]
178+
volume = [ "Jild", "jl." ]
179+
edition = [ "Nashr", "nsh." ]
180+
part = "Qism"
181+
chapter = "Bob"
182+
appendix = [ "Ilova", "Ilovalar" ]
183+
annex = [ "Qo‘shimcha", "Qo‘shimchalar" ]
184+
errata = "Xatoliklar"
185+
acknowledgements = "Minnatdorchilik"
186+
187+
[lang.fa]
188+
volume = [ "جلد", "جلد" ]
189+
edition = [ "نسخه", "ن‌سخه" ]
190+
part = "بخش"
191+
chapter = "فصل"
192+
appendix = [ "پیوست", "پیوست‌ها" ]
193+
annex = [ "ضمیمه", "ضمیمه‌ها" ]
194+
errata = "اشتباهات"
195+
acknowledgements = "تشکرات"
196+
197+
[lang.hr]
198+
volume = [ "Svezak", "sv." ]
199+
edition = [ "Izdanje", "izd." ]
200+
part = "Dio"
201+
chapter = "Poglavlje"
202+
appendix = [ "Dodatak", "Dodaci" ]
203+
annex = [ "Prilog", "Prilozi" ]
204+
errata = "Errata"
205+
acknowledgements = "Zahvale"

0 commit comments

Comments
 (0)