Skip to content

Commit 39baf4a

Browse files
committed
Reformat changelog for better display on generated site
1 parent ed5dcd1 commit 39baf4a

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

CHANGELOG.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Changelog
33
---
44

5-
# Unreleased
5+
## Unreleased
66

7-
## Breaking Changes
7+
### Breaking Changes
88

99
- Convert to ESM to enable easier use of ESM-only dependencies.
1010
- Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
@@ -30,7 +30,7 @@ title: Changelog
3030
will no longer be removed from the reflections they are present on. They are
3131
skipped during rendering with the `notRenderedTags` option.
3232

33-
## Features
33+
### Features
3434

3535
- Add support for TypeScript 5.7
3636
- TypeDoc will now discover entry points from `package.json` exports if they
@@ -80,7 +80,7 @@ title: Changelog
8080
together and will expand/collapse together, #2335.
8181
- API: Introduced a new `app.outputs` object for defining new output strategies.
8282

83-
## Bug Fixes
83+
### Bug Fixes
8484

8585
- TypeDoc now properly flags `readonly` index signatures.
8686
- TypeDoc will now use the first signature's comment for later signatures in
@@ -108,7 +108,7 @@ title: Changelog
108108
one package were incorrectly reported as unused when running with
109109
entryPointStrategy set to packages.
110110

111-
## Thanks!
111+
### Thanks!
112112

113113
- @Huxpro
114114
- @mrfigg
@@ -301,7 +301,7 @@ title: Changelog
301301

302302
- @KNU-K
303303

304-
# v0.26.0 (2024-06-22)
304+
## v0.26.0 (2024-06-22)
305305

306306
### Breaking Changes
307307

@@ -643,7 +643,7 @@ title: Changelog
643643
- @hrueger
644644
- @typhonrt
645645

646-
# v0.25.0 (2023-08-25)
646+
## v0.25.0 (2023-08-25)
647647

648648
### Breaking Changes
649649

@@ -828,7 +828,7 @@ title: Changelog
828828
- Improve detection for legacy JSDoc `@example` tags, #2222.
829829
- The page footer will now appear at the bottom of the page even if the page is short, #2223.
830830

831-
# v0.24.0 (2023-04-08)
831+
## v0.24.0 (2023-04-08)
832832

833833
### Breaking Changes
834834

@@ -1291,7 +1291,7 @@ title: Changelog
12911291

12921292
- If a declaration has multiple comments associated with it, the last one should be used, #1961.
12931293

1294-
# v0.23.0 (2022-06-26)
1294+
## v0.23.0 (2022-06-26)
12951295

12961296
### Breaking Changes
12971297

@@ -1686,7 +1686,7 @@ title: Changelog
16861686
- Validation for non-exported symbols will now only produce one warning per symbol, instead of one warning per reference.
16871687
- Syntax highlighting when the preferred color scheme is dark but dark theme is not explicitly selected will now properly use the dark highlighting theme.
16881688

1689-
# v0.22.0 (2021-09-10)
1689+
## v0.22.0 (2021-09-10)
16901690

16911691
### Breaking Changes
16921692

@@ -1841,7 +1841,7 @@ title: Changelog
18411841
- `readme` could not be set to `none` in a config file, closes #1608
18421842
- Correctly handle minimatch excludes on Windows, closes #1610
18431843

1844-
# v0.21.0 (2021-06-18)
1844+
## v0.21.0 (2021-06-18)
18451845

18461846
### Breaking Changes
18471847

@@ -2211,7 +2211,7 @@ title: Changelog
22112211

22122212
- Initializers should only be included if "simple", closes #1288, #1224, #764
22132213

2214-
# v0.20.0 (2020-12-28)
2214+
## v0.20.0 (2020-12-28)
22152215

22162216
### Breaking Changes
22172217

@@ -2294,7 +2294,7 @@ title: Changelog
22942294

22952295
- @Dergash
22962296

2297-
# v0.19.0 (2020-08-28)
2297+
## v0.19.0 (2020-08-28)
22982298

22992299
### Features
23002300

@@ -2315,7 +2315,7 @@ title: Changelog
23152315
- @krisztianb
23162316
- @MathBunny
23172317

2318-
# v0.18.0 (2020-08-09)
2318+
## v0.18.0 (2020-08-09)
23192319

23202320
### Breaking Changes
23212321

scripts/build_site.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ node scripts/generate_site_plugins.js
77

88
# Build the API docs, only build JSON output here to remove ~2s from
99
# the time it takes to run this script.
10-
node bin/typedoc --json docs/docs.json --readme none
10+
# node bin/typedoc --json docs/docs.json --readme none
1111

1212
# Build the actual site, references the API docs
1313
node bin/typedoc --options site/typedoc.config.jsonc

scripts/create_release.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,14 @@ async function main() {
8686
const heading = patch === "0" ? "#" : "##";
8787
let start = fullChangelog.indexOf(`${heading} ${currentVersion}`);
8888

89-
// If this version isn't in the changelog yet, take everything under # Unreleased and include that
89+
// If this version isn't in the changelog yet, take everything under ## Unreleased and include that
9090
// as this version.
9191
if (start === -1) {
92-
start = fullChangelog.indexOf("# Unreleased");
92+
start = fullChangelog.indexOf("## Unreleased");
9393
if (start === -1) {
9494
start = 0;
9595
} else {
96-
start += "# Unreleased".length;
96+
start += "## Unreleased".length;
9797
}
9898

9999
const date = new Date();
@@ -103,7 +103,7 @@ async function main() {
103103
date.getUTCDate().toString().padStart(2, "0"),
104104
].join("-");
105105
fullChangelog =
106-
"# Unreleased\n\n" +
106+
"## Unreleased\n\n" +
107107
`${heading} ${currentVersion} (${dateStr})` +
108108
fullChangelog.substring(start);
109109
start = fullChangelog.indexOf(`${heading} ${currentVersion}`);

0 commit comments

Comments
 (0)