Skip to content

Commit cf48e87

Browse files
committed
website update
1 parent 80a5804 commit cf48e87

12 files changed

+87
-17
lines changed
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
3+
title: doxygen2docusaurus v2.0.0 released
4+
seo_title: Version 2.0.0 released
5+
description: Version v2.0.0 is a TODO new/maintenance release
6+
keywords:
7+
- xpack
8+
- doxygen2docusaurus
9+
- release
10+
11+
date: 2025-08-08 23:12:21 +0300
12+
13+
authors: ilg-ul
14+
15+
# To be listed in the Releases page.
16+
tags:
17+
- releases
18+
19+
# ----- Custom properties -----------------------------------------------------
20+
21+
version: "2.0.0"
22+
23+
release_tag_url: "https://github.com/xpack/doxygen2docusaurus-cli-ts/tree/v2.0.0"
24+
25+
---
26+
27+
import {PageMetadata} from '@docusaurus/theme-common';
28+
import Image from '@theme/IdealImage';
29+
import CodeBlock from '@theme/CodeBlock';
30+
import Link from '@docusaurus/Link';
31+
32+
import CommonPrerequisites from './_common/_prerequisites.mdx';
33+
import CommonDownloadAnalytics from './_common/_download-analytics.mdx';
34+
35+
Version **2.0.0** is the first publicly available release.
36+
37+
<!-- truncate -->
38+
39+
<PageMetadata title={frontMatter.seo_title} />
40+
41+
The [Doxygen Docusaurus Converter](https://xpack.github.io/doxygen2docusaurus-ts/)
42+
project is a TypeScript ECMAScript Node.js module.
43+
44+
<CommonPrerequisites nodeVersion="20.0.0"/>
45+
46+
## Install
47+
48+
For installation instructions, please refer to the
49+
[Install Guide](/docs/install/)
50+
page.
51+
52+
## Source code
53+
54+
- <Link to={frontMatter.release_tag_url}>GitHub tag v{frontMatter.version} tree</Link>
55+
56+
## Bug fixes
57+
58+
- none
59+
60+
## Enhancements
61+
62+
- none
63+
64+
## Known problems
65+
66+
- none
67+
68+
## CI tests
69+
70+
- none

website/docs/install/_common/_install-cli.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ npm install @xpack/doxygen2docusaurus@latest --save-dev
3535
For a **specific version**, use the explicit version numbers:
3636

3737
<CodeBlock language="sh"> {
38-
`npm install @xpack/doxygen2docusaurus@1.1.0 --save-dev
38+
`npm install @xpack/doxygen2docusaurus@2.0.0 --save-dev
3939
`} </CodeBlock>
4040

4141

@@ -51,7 +51,7 @@ npm install --location=global @xpack/doxygen2docusaurus@latest
5151
For a **specific version**, use the explicit version numbers:
5252

5353
<CodeBlock language="sh"> {
54-
`npm install --location=global @xpack/doxygen2docusaurus@1.1.0
54+
`npm install --location=global @xpack/doxygen2docusaurus@2.0.0
5555
`} </CodeBlock>
5656

5757
## Uninstall
@@ -75,7 +75,7 @@ benefit from it by utilising the `npx` command, as a trampoline to start **doxyg
7575

7676
<CodeBlock language="console"> {
7777
`$ npx doxygen2docusaurus --version
78-
1.1.0
78+
2.0.0
7979
`} </CodeBlock>
8080

8181
However, for regular usage, this method is not efficient, since

website/docs/install/_common/_reproducibility-and-dependencies.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The result appears as follows:
2222
"minimumXpmRequired": "0.20.7",
2323
"dependencies": {
2424
"@xpack/doxygen2docusaurus": {
25-
"specifier": "1.1.0",
25+
"specifier": "2.0.0",
2626
"local": "link",
2727
"platforms": "all"
2828
}

website/docs/maintainer/_common/_fix-open-issues.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ Check GitHub Issues and Pull Requests:
1111
- https://github.com/xpack/doxygen2docusaurus-cli-ts/pulls
1212

1313
and resolve them; assign them to a milestone
14-
(such as <code>1.1.0</code>).
14+
(such as <code>2.0.0</code>).
1515

website/docs/maintainer/_common/_increase-version.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
As required by npm projects, this one also utilises [SemVer](https://semver.org).
99

10-
- Determine the next version (such as <code>1.1.0</code>)
10+
- Determine the next version (such as <code>2.0.0</code>)
1111
- Update the version in the top `package.json` file
1212
- Use the new version, suffixed by `-pre`,
13-
such as <code>1.1.0-pre</code>.
13+
such as <code>2.0.0-pre</code>.

website/docs/maintainer/_common/_prepare-new-blog-post.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616
```
1717
- [[#N](https://github.com/xpack/doxygen2docusaurus-cli-ts/issues/N)]:
1818
```
19-
- **Commit** with the message _**website: blog post release 1.1.0 published**_
19+
- **Commit** with the message _**website: blog post release 2.0.0 published**_

website/docs/maintainer/_common/_prepare-release.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
- Switch to the `development` branch- `npm run fix`
1010
- If there are changes, **commit** all changes to the `development` branch- `npm run test`
1111
- Check the latest commits `npm run git-log`
12-
- Update `CHANGELOG.md`, add a line such as _**\* v1.1.0 published on npmjs.com**_
13-
- **Commit** with the message _**CHANGELOG: publish npm v1.1.0**_
12+
- Update `CHANGELOG.md`, add a line such as _**\* v2.0.0 published on npmjs.com**_
13+
- **Commit** with the message _**CHANGELOG: publish npm v2.0.0**_
1414
- Check the list of files included in the npm package:
1515
```sh
1616
npm run pack

website/docs/maintainer/_common/_set-new-version.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import CodeBlock from '@theme/CodeBlock';
1010
Execute the following within the project folder:
1111

1212
<CodeBlock language="sh"> {
13-
`npm version 1.1.0
13+
`npm version 2.0.0
1414
`} </CodeBlock>
1515

1616
The `postversion` npm script should also update tags via

website/docs/maintainer/_common/_tag-npm-latest.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ npm dist-tag ls @xpack/doxygen2docusaurus
1818
When the release is considered stable, promote it as `latest`:
1919

2020
<CodeBlock language="sh"> {
21-
`npm dist-tag add @xpack/doxygen2docusaurus@1.1.0 latest
21+
`npm dist-tag add @xpack/doxygen2docusaurus@2.0.0 latest
2222
`} </CodeBlock>
2323

2424
Check the result:
@@ -30,5 +30,5 @@ Check the result:
3030
Should the release prove problematic and require unpublishing:
3131

3232
<CodeBlock language="sh"> {
33-
`npm unpublish @xpack/doxygen2docusaurus@1.1.0
33+
`npm unpublish @xpack/doxygen2docusaurus@2.0.0
3434
`} </CodeBlock>

website/docs/maintainer/_common/_update-changelog.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@
3131
```txt
3232
*
3333
```
34-
- Add a new entry such as _**\* v1.1.0 prepared**_
35-
- **Commit** with the message _**prepare v1.1.0**_
34+
- Add a new entry such as _**\* v2.0.0 prepared**_
35+
- **Commit** with the message _**prepare v2.0.0**_

0 commit comments

Comments
 (0)