Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions assets/banners.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"//": [
"Banner that shows at the top of the docs pages.",
"Nothing shows right now because there is no 'index' entry.",
"To put a banner up, copy 'example' below into 'index' and edit the text. Remove 'index' again to take it down.",
"text is required. link, type, startDate and endDate are optional.",
"type is one of 'default' (blue), 'warning' (orange), 'error' (red).",
"startDate and endDate are ISO dates that limit when the banner shows."
],
"websiteBanners": {
"example": {
"text": "webpack 5.x.0 is now available, read the release notes",
"link": "/blog/posts/your-release-post",
"type": "default",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-01-08T00:00:00.000Z"
}
}
}
2 changes: 1 addition & 1 deletion scripts/html/doc-kit.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export default {
web: {
project: 'webpack',
useAbsoluteURLs: true,
remoteConfigUrl: null,
remoteConfigUrl: '/assets/banners.json',
title: VERSION ? `Webpack ${MAJOR_VERSION} Documentation` : 'Webpack',
editURL:
'https://github.com/webpack/webpack-doc-kit/blob/main/pages/{path}.md',
Expand Down
Loading