Skip to content

Commit 6eaa567

Browse files
docs: update changelog
1 parent 39b5ea5 commit 6eaa567

File tree

1 file changed

+22
-67
lines changed

1 file changed

+22
-67
lines changed

CHANGELOG/CHANGELOG-0.3.md

Lines changed: 22 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -4,101 +4,56 @@ All notable changes to the "shiroa" will be documented in this file.
44

55
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
66

7-
## v0.3.1 - [2025-06-30]
7+
## v0.3.1 - [2025-12-06]
88

9-
The diff between v0.3.1-rc2 and v0.3.1-rc3 is rendered at the [section](#diff-v031-rc2v031-rc3).
10-
11-
- Bumped shiroa package to v0.2.3 in https://github.com/Myriad-Dreamin/shiroa/pull/131 and https://github.com/Myriad-Dreamin/shiroa/pull/141
9+
- Bumped shiroa package to v0.3.1 in https://github.com/Myriad-Dreamin/shiroa/pull/131, https://github.com/Myriad-Dreamin/shiroa/pull/141, https://github.com/Myriad-Dreamin/shiroa/pull/221, and https://github.com/Myriad-Dreamin/shiroa/pull/223
1210
- Bumped zebraw to v0.5.2 in https://github.com/Myriad-Dreamin/shiroa/pull/139
11+
- Bumped typst to v0.14.0 in https://github.com/Myriad-Dreamin/shiroa/pull/219
12+
- Bumped typst.ts to v0.6.1-rc3 in https://github.com/Myriad-Dreamin/shiroa/pull/193
1313

1414
### Theme
1515

16-
- feat(theme): introduce startlight in https://github.com/Myriad-Dreamin/shiroa/pull/157, https://github.com/Myriad-Dreamin/shiroa/pull/160, https://github.com/Myriad-Dreamin/shiroa/pull/161, https://github.com/Myriad-Dreamin/shiroa/pull/162, https://github.com/Myriad-Dreamin/shiroa/pull/163, https://github.com/Myriad-Dreamin/shiroa/pull/164, and https://github.com/Myriad-Dreamin/shiroa/pull/166
16+
- Introduced startlight in https://github.com/Myriad-Dreamin/shiroa/pull/157, https://github.com/Myriad-Dreamin/shiroa/pull/160, https://github.com/Myriad-Dreamin/shiroa/pull/161, https://github.com/Myriad-Dreamin/shiroa/pull/162, https://github.com/Myriad-Dreamin/shiroa/pull/163, https://github.com/Myriad-Dreamin/shiroa/pull/164, and https://github.com/Myriad-Dreamin/shiroa/pull/166
17+
- Rewrote mdbook theme to pure typst in https://github.com/Myriad-Dreamin/shiroa/pull/168, https://github.com/Myriad-Dreamin/shiroa/pull/191, and https://github.com/Myriad-Dreamin/shiroa/pull/205
18+
- Checking and Documented `description`, `authors`, `github-link`, and `discord-link` in https://github.com/Myriad-Dreamin/shiroa/pull/206, https://github.com/Myriad-Dreamin/shiroa/pull/209, https://github.com/Myriad-Dreamin/shiroa/pull/192, and https://github.com/Myriad-Dreamin/shiroa/pull/194
19+
- Added `x-url-base` and `x-current` in https://github.com/Myriad-Dreamin/shiroa/pull/185, https://github.com/Myriad-Dreamin/shiroa/pull/195, and https://github.com/Myriad-Dreamin/shiroa/pull/199
20+
- Supporting divider in toc in https://github.com/Myriad-Dreamin/shiroa/pull/188
1721

1822
### Package
1923

2024
- (Fix) Corrected show rule for equations in https://github.com/Myriad-Dreamin/shiroa/pull/120
2125
- (Fix) Strengthened `plain-text` implementation in https://github.com/Myriad-Dreamin/shiroa/pull/122 and https://github.com/Myriad-Dreamin/shiroa/pull/138
26+
- (Fix) Corrected outer-height value in xcommand-html by @minimarimo3 in https://github.com/Myriad-Dreamin/shiroa/pull/171
27+
- (Fix) Resolved multi-byte character issue in auto description generation by @minimarimo3 in https://github.com/Myriad-Dreamin/shiroa/pull/173 and https://github.com/Myriad-Dreamin/shiroa/pull/177
2228
- Set up package tests in https://github.com/Myriad-Dreamin/shiroa/pull/121
2329
- Removed cross-link protocol usages in https://github.com/Myriad-Dreamin/shiroa/pull/130 and https://github.com/Myriad-Dreamin/shiroa/pull/159
2430

2531
### CLI
2632

33+
- (Test) Added and testing a minimal project to be used in `shiroa init` section in https://github.com/Myriad-Dreamin/shiroa/pull/214
34+
- (Change) Deprecating `-w` flag in https://github.com/Myriad-Dreamin/shiroa/pull/215
2735
- Hot reloading necessary documents and themes in https://github.com/Myriad-Dreamin/shiroa/pull/158
2836
- Pretty printing compilation in https://github.com/Myriad-Dreamin/shiroa/pull/124
2937
- Ignoring the infamous foreign object warning in https://github.com/Myriad-Dreamin/shiroa/pull/125
3038
- Fully parallelized compilation in https://github.com/Myriad-Dreamin/shiroa/pull/126
3139
- Watching compilation when serving in https://github.com/Myriad-Dreamin/shiroa/pull/127
3240
- Updated title formatting by @Enter-tainer in https://github.com/Myriad-Dreamin/shiroa/pull/152
3341
- Using TextExport that respects style tag in https://github.com/Myriad-Dreamin/shiroa/pull/154
42+
- Initializing page.typ with correct book.typ path by @Sinofine in https://github.com/Myriad-Dreamin/shiroa/pull/174
43+
- Not longer generating description from CLI in https://github.com/Myriad-Dreamin/shiroa/pull/210
3444

3545
### Misc
3646

37-
- Updated README.md and installation.typ by @HoiGe in https://github.com/Myriad-Dreamin/shiroa/pull/119
3847
- Ensured wasm module matches frontend build by @kxxt in https://github.com/Myriad-Dreamin/shiroa/pull/101
48+
- Updated README.md and installation.typ by @HoiGe in https://github.com/Myriad-Dreamin/shiroa/pull/119
3949
- Update doucmentation about support section and todo list in https://github.com/Myriad-Dreamin/shiroa/pull/137
4050
- Refactored rendering logic by @QuadnucYard in https://github.com/Myriad-Dreamin/shiroa/pull/155 and https://github.com/Myriad-Dreamin/shiroa/pull/165
41-
42-
### Diff v0.3.1-rc2...v0.3.1-rc3
43-
44-
```diff
45-
-## v0.3.1 - [2025-04-25]
46-
+## v0.3.1 - [2025-06-30]
47-
48-
+### Theme
49-
+
50-
+- feat(theme): introduce startlight in https://github.com/Myriad-Dreamin/shiroa/pull/157, https://github.com/Myriad-Dreamin/shiroa/pull/160, https://github.com/Myriad-Dreamin/shiroa/pull/161, https://github.com/Myriad-Dreamin/shiroa/pull/162, https://github.com/Myriad-Dreamin/shiroa/pull/163, https://github.com/Myriad-Dreamin/shiroa/pull/164, and https://github.com/Myriad-Dreamin/shiroa/pull/166
51-
+
52-
### Package
53-
54-
- (Fix) Corrected show rule for equations in https://github.com/Myriad-Dreamin/shiroa/pull/120
55-
- (Fix) Strengthened `plain-text` implementation in https://github.com/Myriad-Dreamin/shiroa/pull/122 and https://github.com/Myriad-Dreamin/shiroa/pull/138
56-
- Set up package tests in https://github.com/Myriad-Dreamin/shiroa/pull/121
57-
-- Supported `cross-link` in HTML export in https://github.com/Myriad-Dreamin/shiroa/pull/130
58-
+- Removed cross-link protocol usages in https://github.com/Myriad-Dreamin/shiroa/pull/130 and https://github.com/Myriad-Dreamin/shiroa/pull/159
59-
60-
### CLI
61-
62-
+- Hot reloading necessary documents and themes in https://github.com/Myriad-Dreamin/shiroa/pull/158
63-
- Pretty printing compilation in https://github.com/Myriad-Dreamin/shiroa/pull/124
64-
- Ignoring the infamous foreign object warning in https://github.com/Myriad-Dreamin/shiroa/pull/125
65-
- Fully parallelized compilation in https://github.com/Myriad-Dreamin/shiroa/pull/126
66-
- Watching compilation when serving in https://github.com/Myriad-Dreamin/shiroa/pull/127
67-
+- Updated title formatting by @Enter-tainer in https://github.com/Myriad-Dreamin/shiroa/pull/152
68-
+- Using TextExport that respects style tag in https://github.com/Myriad-Dreamin/shiroa/pull/154
69-
70-
### Misc
71-
72-
- Updated README.md and installation.typ by @HoiGe in https://github.com/Myriad-Dreamin/shiroa/pull/119
73-
- Ensured wasm module matches frontend build by @kxxt in https://github.com/Myriad-Dreamin/shiroa/pull/101
74-
- Update doucmentation about support section and todo list in https://github.com/Myriad-Dreamin/shiroa/pull/137
75-
+- Refactored rendering logic by @QuadnucYard in https://github.com/Myriad-Dreamin/shiroa/pull/155 and https://github.com/Myriad-Dreamin/shiroa/pull/165
76-
```
77-
78-
### Diff v0.3.1-rc1...v0.3.1-rc2
79-
80-
```diff
81-
-## v0.3.1 - [2025-03-30]
82-
+## v0.3.1 - [2025-04-25]
83-
84-
-- Bumped shiroa package to v0.2.2 in https://github.com/Myriad-Dreamin/shiroa/pull/131
85-
+- Bumped shiroa package to v0.2.3 in https://github.com/Myriad-Dreamin/shiroa/pull/131 and https://github.com/Myriad-Dreamin/shiroa/pull/141
86-
+- Bumped zebraw to v0.5.2 in https://github.com/Myriad-Dreamin/shiroa/pull/139
87-
88-
### Package
89-
90-
- (Fix) Corrected show rule for equations in https://github.com/Myriad-Dreamin/shiroa/pull/120
91-
-- (Fix) Strengthened `plain-text` implementation in https://github.com/Myriad-Dreamin/shiroa/pull/122
92-
+- (Fix) Strengthened `plain-text` implementation in https://github.com/Myriad-Dreamin/shiroa/pull/122 and https://github.com/Myriad-Dreamin/shiroa/pull/138
93-
- Set up package tests in https://github.com/Myriad-Dreamin/shiroa/pull/121
94-
- Supported `cross-link` in HTML export in https://github.com/Myriad-Dreamin/shiroa/pull/130
95-
96-
@@ -26,6 +27,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
97-
98-
- Updated README.md and installation.typ by @HoiGe in https://github.com/Myriad-Dreamin/shiroa/pull/119
99-
- Ensured wasm module matches frontend build by @kxxt in https://github.com/Myriad-Dreamin/shiroa/pull/101
100-
+- Update doucmentation about support section and todo list in https://github.com/Myriad-Dreamin/shiroa/pull/137
101-
```
51+
- Publishing typst packages by workflow in https://github.com/Myriad-Dreamin/shiroa/pull/200, https://github.com/Myriad-Dreamin/shiroa/pull/201, and https://github.com/Myriad-Dreamin/shiroa/pull/202
52+
- (Docs) Fixed incorrect argument name in `shiroa help build` by @xiyihan0 in https://github.com/Myriad-Dreamin/shiroa/pull/220
53+
- (Docs) Fixed book.toml => book.typ typo by @kaliiiiiiiiii in https://github.com/Myriad-Dreamin/shiroa/pull/204
54+
- (Docs) Updated book metadata descriptions and enhance theme docs in https://github.com/Myriad-Dreamin/shiroa/pull/218
55+
- (Docs) Updated introduction, FAQ, get started, and installation guides in https://github.com/Myriad-Dreamin/shiroa/pull/213
56+
- (Docs) Turned en-dash into two hypen (long flag) in https://github.com/Myriad-Dreamin/shiroa/pull/208
10257

10358
**Full Changelog**: https://github.com/Myriad-Dreamin/shiroa/compare/v0.3.0...v0.3.1
10459

0 commit comments

Comments
 (0)