Skip to content

Commit 2092187

Browse files
authored
docs(blog): retitle v1.0 blog post and add announcement bar (#140)
I took inspiration from https://docusaurus.io/blog/releases/3.0 for the title and path. Refs: https://docusaurus.io/docs/api/themes/configuration#announcement-bar
1 parent e76f83f commit 2092187

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

blog/release.md renamed to blog/releases/1.0.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
slug: v1-release
3-
title: Release notes v1
4-
date: 2025-07-25
2+
title: Announcing ImageJS 1.0
3+
date: 2025-08-20
54
---
65

7-
We're excited to announce the release of a new major version of ImageJS.
6+
We're excited to announce the release of a new major version of ImageJS!
87
This version brings TypeScript support and a more intuitive API while maintaining the powerful image processing capabilities you love.
98

109
<!-- truncate -->
@@ -150,8 +149,8 @@ The new `blackRois` and `whiteRois` properties provide more intuitive access to
150149

151150
For more information, please visit these tutorials:
152151

153-
- [Image segmentation with `threshold()` and `fromMask()`](../docs/Tutorials/Image%20segmentation%20with%20threshold)
154-
- [Image segmentation with `watershed()`](../docs/Tutorials/Image%20segmentation%20with%20watershed)
152+
- [Image segmentation with `threshold()` and `fromMask()`](../../docs/Tutorials/Image%20segmentation%20with%20threshold)
153+
- [Image segmentation with `watershed()`](../../docs/Tutorials/Image%20segmentation%20with%20watershed)
155154

156155
### Sobel and Scharr filters
157156

@@ -267,7 +266,7 @@ The following deprecated features have been removed:
267266

268267
- `countAlphaPixel()` - Use custom pixel counting with [`getPixel()`](https://api.image-js.org/classes/index.Image.html#getpixel 'API link on getPixel').
269268
- `paintLabels()` and `roi.paint()` - Features have been removed due to dependency issues. We plan to add it back in future updates.
270-
- `warpingFourPoints()` - Use [`getPerspectiveWarpMatrix()`](../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on getPerspectiveWarp') + [`transform()`](release.md#transform) instead.
269+
- `warpingFourPoints()` - Use [`getPerspectiveWarpMatrix()`](../../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on getPerspectiveWarp') + [`transform()`](#transform) instead.
271270
- 32-bit color depth support and `abs()` have been removed.
272271
- `CMYK` and `HSL` color models have been removed.
273272
- `paintMasks()` has been removed. Use [`paintMask()`](https://api.image-js.org/classes/index.Image.html#paintmask 'API link on paintMask')+ a `for` loop.
@@ -304,7 +303,7 @@ const matrix = getPerspectiveWarp(sourcePoints);
304303
const warped = img.transform(matrix);
305304
```
306305

307-
For more details, [visit our tutorial](/docs/Tutorials/Applying%20transform%20function%20on%20images 'internal link on transform function tutorial') on how image transformations work how they can be used.
306+
For more details, [visit our tutorial](../../docs/Tutorials/Applying%20transform%20function%20on%20images 'internal link on transform function tutorial') on how image transformations work how they can be used.
308307

309308
### Bicubic interpolation
310309

@@ -324,11 +323,11 @@ const resized = img.resize(800, 600, { interpolation: 'bicubic' });
324323
const prewitt = img.derivative({ filter: 'prewitt' });
325324
```
326325

327-
**Use cases**: Object detection, image segmentation, feature extraction. You can [learn more about it here](../docs/Features/Morphology/Morphological%20Gradient 'internal link on morphological gradient').
326+
**Use cases**: Object detection, image segmentation, feature extraction. You can [learn more about it here](../../docs/Features/Morphology/Morphological%20Gradient 'internal link on morphological gradient').
328327

329328
### Migration from deprecated methods
330329

331-
`warpingFourPoints()` has been removed. Now you have [`getPerspectiveWarp()`](../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on perspective warp') that returns a matrix that can be applied on the image of interest in a new `transform()`.
330+
`warpingFourPoints()` has been removed. Now you have [`getPerspectiveWarp()`](../../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on perspective warp') that returns a matrix that can be applied on the image of interest in a new `transform()`.
332331

333332
```ts
334333
// Before
@@ -339,7 +338,7 @@ const matrix = getPerspectiveWarp(corners);
339338
const warped = img.transform(matrix);
340339
```
341340

342-
**Use cases**: Rectification of a perspective angle of an image. You can learn more about it [here](../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on perspective warp').
341+
**Use cases**: Rectification of a perspective angle of an image. You can learn more about it [here](../../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on perspective warp').
343342

344343
### `merge()`
345344

docusaurus.config.js

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,6 @@ async function createConfig() {
5252
// For GitHub pages deployment, it is often '/<projectName>/'
5353
baseUrl: '/',
5454

55-
// GitHub pages deployment config.
56-
// If you aren't using GitHub pages, you don't need these.
57-
organizationName: 'Zakodium', // Usually your GitHub org/user name.
58-
projectName: 'image-js', // Usually your repo name.
59-
6055
plugins: [demoLoaderPlugin],
6156

6257
onBrokenLinks: 'throw',
@@ -114,6 +109,14 @@ async function createConfig() {
114109
// Replace with your project's social card
115110
image: 'img/docusaurus-social-card.jpg',
116111
colorMode: {},
112+
announcementBar: {
113+
id: 'release-1.0',
114+
content:
115+
'ImageJS 1.0 has been released! <a href="/blog/releases/1.0">Click here</a> to read our announcement post.',
116+
textColor: '#fff',
117+
backgroundColor: '#1c4ed8',
118+
isCloseable: true,
119+
},
117120
navbar: {
118121
title: 'ImageJS',
119122
logo: {

0 commit comments

Comments
 (0)