@cbnventures/docusaurus-preset-nova 0.25.2 → 0.27.0

package/nova-config.d.ts

@@ -1,4 +1,10 @@
-import type { ProcessBlogPostsFn, ReadingTimeFunctionOption } from '@docusaurus/plugin-content-blog';
+import type {
+  Options as DocusaurusBlogOptions,
+  ProcessBlogPostsFn,
+  ReadingTimeFunctionOption,
+} from '@docusaurus/plugin-content-blog';
+import type { Options as DocusaurusDocsOptions } from '@docusaurus/plugin-content-docs';
+import type { Options as DocusaurusPagesOptions } from '@docusaurus/plugin-content-pages';
 import type {
   DocusaurusConfig,
   FutureV4Config,
@@ -157,8 +163,8 @@ export type NovaPresetPluginsDocsConfigShowLastUpdateTime = boolean | undefined;
 // Show the author who last updated each doc page. Defaults to false.
 export type NovaPresetPluginsDocsConfigShowLastUpdateAuthor = boolean | undefined;
 
-// Parse number prefixes from file names for sidebar ordering. Set as false to disable. Defaults to true.
-export type NovaPresetPluginsDocsConfigNumberPrefixParser = boolean | undefined;
+// Parse number prefixes from file names for sidebar ordering. Accepts the default toggle or a custom parser. Defaults to true.
+export type NovaPresetPluginsDocsConfigNumberPrefixParser = DocusaurusDocsOptions['numberPrefixParser'];
 
 // Show breadcrumb navigation on doc pages. Defaults to true.
 export type NovaPresetPluginsDocsConfigBreadcrumbs = boolean | undefined;
@@ -196,7 +202,7 @@ export type NovaPresetPluginsDocsConfigVersionOptionsLabel = string | undefined;
 // Banner style shown at the top of docs - "none" to hide, or a version status indicator.
 export type NovaPresetPluginsDocsConfigVersionOptionsBanner = 'none' | 'unreleased' | 'unmaintained' | undefined;
 
-// Show a badge with the version label at the top of each doc. Defaults to true.
+// Show a badge with the version label at the top of each doc. Defaults to true only when multiple versions are included.
 export type NovaPresetPluginsDocsConfigVersionOptionsBadge = boolean | undefined;
 
 // Prevent search engines from indexing this version. Defaults to false.
@@ -218,7 +224,7 @@ export type NovaPresetPluginsDocsConfigVersionOptions = {
 // Per-version configuration keyed by version name (e.g., { "1.0.0": { label: "v1.0", banner: "unmaintained" } }).
 export type NovaPresetPluginsDocsConfigVersions = Record<string, NovaPresetPluginsDocsConfigVersionOptions> | undefined;
 
-// Path to the tags file, or false/null to disable (e.g., "tags.yml"). Defaults to "tags.yml".
+// Path to the tags file, or false/null to disable (e.g., "tags.yml"). No tags file is configured by default.
 export type NovaPresetPluginsDocsConfigTags = string | false | null | undefined;
 
 // Behavior when inline tags are detected. Defaults to "warn".
@@ -227,8 +233,8 @@ export type NovaPresetPluginsDocsConfigOnInlineTags = ReportingSeverity | undefi
 // URL route for the tags section, appended to routeBasePath (e.g., "tags"). Defaults to "tags".
 export type NovaPresetPluginsDocsConfigTagsBasePath = string | undefined;
 
-// Enable admonition syntax in Markdown (:::note, :::tip, etc.). Defaults to true.
-export type NovaPresetPluginsDocsConfigAdmonitions = boolean | undefined;
+// Enable or configure admonition syntax in Markdown (:::note, :::tip, etc.). Defaults to true.
+export type NovaPresetPluginsDocsConfigAdmonitions = DocusaurusDocsOptions['admonitions'];
 
 // Remark plugins for Markdown processing.
 export type NovaPresetPluginsDocsConfigRemarkPlugins = unknown[] | undefined;
@@ -267,7 +273,7 @@ export type NovaPresetPluginsDocsConfigDocTagsListComponent = string | undefined
 export type NovaPresetPluginsDocsConfigDocCategoryGeneratedIndexComponent = string | undefined;
 
 // Custom callback to generate sidebar items from autogenerated sections.
-export type NovaPresetPluginsDocsConfigSidebarItemsGenerator = ((generatorArgs: Record<string, unknown>) => unknown[] | Promise<unknown[]>) | undefined;
+export type NovaPresetPluginsDocsConfigSidebarItemsGenerator = DocusaurusDocsOptions['sidebarItemsGenerator'];
 
 // Docs plugin options - pass-through to @docusaurus/plugin-content-docs.
 export type NovaPresetPluginsDocsConfig = {
@@ -356,7 +362,7 @@ export type NovaPresetPluginsBlogConfigBlogSidebarTitle = string | undefined;
 // Show estimated reading time on blog posts. Defaults to true.
 export type NovaPresetPluginsBlogConfigShowReadingTime = boolean | undefined;
 
-// Truncate marker regex for the blog post excerpt. Defaults to /<!--\s*truncate\s*-->/.
+// Truncate marker regex for the blog post excerpt. Defaults to Docusaurus's HTML-comment and JSX-comment markers.
 export type NovaPresetPluginsBlogConfigTruncateMarker = RegExp | undefined;
 
 // Sort order for blog posts. Defaults to "descending".
@@ -391,27 +397,30 @@ export type NovaPresetPluginsBlogConfigOnInlineAuthors = ReportingSeverity | und
 // Behavior when blog posts without a truncate marker are detected. Defaults to "warn".
 export type NovaPresetPluginsBlogConfigOnUntruncatedBlogPosts = ReportingSeverity | undefined;
 
-// Path to the tags file, or false/null to disable (e.g., "tags.yml"). Defaults to "tags.yml".
+// Path to the tags file, or false/null to disable (e.g., "tags.yml"). No tags file is configured by default.
 export type NovaPresetPluginsBlogConfigTags = string | false | null | undefined;
 
 // Behavior when inline tags are detected. Defaults to "warn".
 export type NovaPresetPluginsBlogConfigOnInlineTags = ReportingSeverity | undefined;
 
-// Feed format - array of types, single type, "all" for all formats, or null to disable. Defaults to null.
+// Feed format - array of types, single type, "all" for all formats, or null to disable. Defaults to RSS and Atom.
 export type NovaPresetPluginsBlogConfigFeedOptionsType = ('rss' | 'atom' | 'json')[] | 'all' | 'rss' | 'atom' | 'json' | null | undefined;
 
-// Feed title override. Defaults to the site title.
+// Feed title override. Defaults to the site title followed by "Blog".
 export type NovaPresetPluginsBlogConfigFeedOptionsTitle = string | undefined;
 
-// Feed description override. Defaults to the site tagline.
+// Feed description override. Defaults to the site title followed by "Blog".
 export type NovaPresetPluginsBlogConfigFeedOptionsDescription = string | undefined;
 
-// Copyright notice included in the feed.
+// Copyright notice included in the feed. Defaults to an empty string.
 export type NovaPresetPluginsBlogConfigFeedOptionsCopyright = string | undefined;
 
-// Language code for the feed (e.g., "en").
+// Language code for the feed (e.g., "en"). Defaults to the current locale.
 export type NovaPresetPluginsBlogConfigFeedOptionsLanguage = string | undefined;
 
+// Custom callback to transform the generated feed items.
+export type NovaPresetPluginsBlogConfigFeedOptionsCreateFeedItems = NonNullable<DocusaurusBlogOptions['feedOptions']>['createFeedItems'];
+
 // Maximum number of feed items, or false/null for unlimited. Defaults to 20.
 export type NovaPresetPluginsBlogConfigFeedOptionsLimit = number | false | null | undefined;
 
@@ -428,13 +437,14 @@ export type NovaPresetPluginsBlogConfigFeedOptions = {
   description?: NovaPresetPluginsBlogConfigFeedOptionsDescription;
   copyright?: NovaPresetPluginsBlogConfigFeedOptionsCopyright;
   language?: NovaPresetPluginsBlogConfigFeedOptionsLanguage;
+  createFeedItems?: NovaPresetPluginsBlogConfigFeedOptionsCreateFeedItems;
   limit?: NovaPresetPluginsBlogConfigFeedOptionsLimit;
   xslt?: NovaPresetPluginsBlogConfigFeedOptionsXslt;
   [key: string]: unknown;
 } | undefined;
 
-// Enable admonition syntax in Markdown. Defaults to true.
-export type NovaPresetPluginsBlogConfigAdmonitions = boolean | undefined;
+// Enable or configure admonition syntax in Markdown. Defaults to true.
+export type NovaPresetPluginsBlogConfigAdmonitions = DocusaurusBlogOptions['admonitions'];
 
 // Remark plugins for Markdown processing.
 export type NovaPresetPluginsBlogConfigRemarkPlugins = unknown[] | undefined;
@@ -560,8 +570,8 @@ export type NovaPresetPluginsPagesConfigShowLastUpdateTime = boolean | undefined
 // Show the author who last updated each page. Defaults to false.
 export type NovaPresetPluginsPagesConfigShowLastUpdateAuthor = boolean | undefined;
 
-// Enable admonition syntax in Markdown. Defaults to true.
-export type NovaPresetPluginsPagesConfigAdmonitions = boolean | undefined;
+// Enable or configure admonition syntax in Markdown. Defaults to true.
+export type NovaPresetPluginsPagesConfigAdmonitions = DocusaurusPagesOptions['admonitions'];
 
 // Remark plugins for Markdown processing.
 export type NovaPresetPluginsPagesConfigRemarkPlugins = unknown[] | undefined;
@@ -614,10 +624,10 @@ export type NovaPresetPluginsSitemapConfigIgnorePatterns = string[] | undefined;
 // Format of the lastmod entry - "date" for YYYY-MM-DD, "datetime" for ISO 8601, or null to omit. Defaults to null.
 export type NovaPresetPluginsSitemapConfigLastmod = 'date' | 'datetime' | null | undefined;
 
-// Change frequency hint for search engines, or null to omit. Defaults to null.
+// Change frequency hint for search engines, or null to omit. Defaults to "weekly".
 export type NovaPresetPluginsSitemapConfigChangefreq = 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'always' | 'never' | null | undefined;
 
-// Priority value between 0.0 and 1.0 for search engines, or null to omit. Defaults to null.
+// Priority value between 0.0 and 1.0 for search engines, or null to omit. Defaults to 0.5.
 export type NovaPresetPluginsSitemapConfigPriority = number | null | undefined;
 
 // Sitemap entry with URL, last modified date, change frequency, and priority.
@@ -688,30 +698,50 @@ export type NovaPresetProgressBarConfigMinimum = number | undefined;
 // CSS easing function for the progress animation (e.g., "ease", "linear"). Defaults to "ease".
 export type NovaPresetProgressBarConfigEasing = string | undefined;
 
+// Positioning strategy for the progress transform. An empty string lets Nova detect the best strategy. Defaults to "".
+export type NovaPresetProgressBarConfigPositionUsing = '' | 'translate3d' | 'translate' | 'margin' | undefined;
+
 // Animation speed in milliseconds (e.g., 200). Defaults to 200.
 export type NovaPresetProgressBarConfigSpeed = number | undefined;
 
 // Enable automatic trickle increments. Defaults to true.
 export type NovaPresetProgressBarConfigTrickle = boolean | undefined;
 
-// Trickle increment speed in milliseconds (e.g., 200). Defaults to 200.
+// Amount added by each automatic trickle increment. Defaults to 0.02.
+export type NovaPresetProgressBarConfigTrickleRate = number | undefined;
+
+// Trickle increment interval in milliseconds. Defaults to 800.
 export type NovaPresetProgressBarConfigTrickleSpeed = number | undefined;
 
 // Show the spinner element alongside the progress bar. Defaults to true.
 export type NovaPresetProgressBarConfigShowSpinner = boolean | undefined;
 
+// CSS selector used to find the bar element in the template. Defaults to '[role="bar"]'.
+export type NovaPresetProgressBarConfigBarSelector = string | undefined;
+
+// CSS selector used to find the spinner element in the template. Defaults to '[role="spinner"]'.
+export type NovaPresetProgressBarConfigSpinnerSelector = string | undefined;
+
 // CSS selector for the progress bar parent element (e.g., "body"). Defaults to "body".
 export type NovaPresetProgressBarConfigParent = string | undefined;
 
+// HTML template containing the configured bar and spinner selectors.
+export type NovaPresetProgressBarConfigTemplate = string | undefined;
+
 // Progress bar appearance and behavior.
 export type NovaPresetProgressBarConfig = {
   minimum?: NovaPresetProgressBarConfigMinimum;
   easing?: NovaPresetProgressBarConfigEasing;
+  positionUsing?: NovaPresetProgressBarConfigPositionUsing;
   speed?: NovaPresetProgressBarConfigSpeed;
   trickle?: NovaPresetProgressBarConfigTrickle;
+  trickleRate?: NovaPresetProgressBarConfigTrickleRate;
   trickleSpeed?: NovaPresetProgressBarConfigTrickleSpeed;
   showSpinner?: NovaPresetProgressBarConfigShowSpinner;
+  barSelector?: NovaPresetProgressBarConfigBarSelector;
+  spinnerSelector?: NovaPresetProgressBarConfigSpinnerSelector;
   parent?: NovaPresetProgressBarConfigParent;
+  template?: NovaPresetProgressBarConfigTemplate;
   [key: string]: unknown;
 };
 
@@ -782,6 +812,9 @@ export type NovaPresetOptionsPlugins = NovaPresetPlugins | undefined;
 // Analytics integrations.
 export type NovaPresetOptionsAnalytics = NovaPresetAnalytics | undefined;
 
+// Persist webpack caches to disk during development and production builds. Defaults to false.
+export type NovaPresetOptionsPersistentCache = boolean | undefined;
+
 // Show a progress bar during page transitions. Defaults to false.
 export type NovaPresetOptionsProgressBar = NovaPresetProgressBar | undefined;
 
@@ -794,12 +827,13 @@ export type NovaPresetOptionsIconSafelist = string[] | undefined;
 // Maximum size in MiB any emitted JavaScript bundle file may reach before the build fails, or false to disable. Defaults to 3.
 export type NovaPresetOptionsMaxBundleFileSize = number | false | undefined;
 
-// Nova preset options - identity, overrides, plugins, analytics, progress bar, search, icon safelist, and bundle size guard.
+// Nova preset options - identity, overrides, plugins, analytics, cache policy, progress bar, search, icon safelist, and bundle size guard.
 export type NovaPresetOptions = {
   preset: NovaPresetName;
   overrides?: NovaPresetOptionsOverrides;
   plugins?: NovaPresetOptionsPlugins;
   analytics?: NovaPresetOptionsAnalytics;
+  persistentCache?: NovaPresetOptionsPersistentCache;
   progressBar?: NovaPresetOptionsProgressBar;
   search?: NovaPresetOptionsSearch;
   iconSafelist?: NovaPresetOptionsIconSafelist;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cbnventures/docusaurus-preset-nova",
-  "version": "0.25.2",
+  "version": "0.27.0",
   "description": "Scripts, templates, and project configuration for the common JavaScript and TypeScript developer",
   "keywords": [
     "eslint",
@@ -55,6 +55,7 @@
     "./types/config": "./nova-config.d.ts",
     "./types/sidebars": "./nova-sidebars.d.ts"
   },
+  "type": "module",
   "files": [
     "./assets",
     "./bin",
@@ -75,6 +76,14 @@
     "dev:watch-theme": "tsc --project tsconfig.theme.json --watch",
     "dev:watch-cli": "tsc --project tsconfig.cli.json --watch",
     "dev:fix-shiki-import": "node ../../scripts/fix-shiki-import.mjs --watch",
+    "check": "node ../../scripts/nova-run-scripts.mjs --sequential 'check:*'",
+    "check:lint": "eslint ./ --max-warnings=0",
+    "check:types-plugin": "node ../../scripts/nova-type-check.mjs --project tsconfig.plugin.json",
+    "check:types-theme": "node ../../scripts/nova-type-check.mjs --project tsconfig.theme.json",
+    "check:types-worker": "node ../../scripts/nova-type-check.mjs --project tsconfig.worker.json",
+    "check:types-cli": "node ../../scripts/nova-type-check.mjs --project tsconfig.cli.json",
+    "check:types-config": "node ../../scripts/nova-type-check.mjs --project tsconfig.config.json",
+    "check:test": "vitest run",
     "build": "node ../../scripts/nova-run-scripts.mjs --sequential 'build:*'",
     "build:transpile-theme": "tsc --project tsconfig.theme.json --outDir ./build --skipLibCheck",
     "build:transpile-plugin": "tsc --project tsconfig.plugin.json --outDir ./build --skipLibCheck",
@@ -84,14 +93,6 @@
     "build:fix-shiki-import": "node ../../scripts/fix-shiki-import.mjs",
     "build:copy-styles": "node ../../scripts/copy-styles.mjs",
     "build:fix-perms": "shx chmod +x ./build/src/cli/index.js",
-    "check": "node ../../scripts/nova-run-scripts.mjs --sequential 'check:*'",
-    "check:lint": "eslint ./ --max-warnings=0",
-    "check:types-plugin": "node ../../scripts/nova-type-check.mjs --project tsconfig.plugin.json",
-    "check:types-theme": "node ../../scripts/nova-type-check.mjs --project tsconfig.theme.json",
-    "check:types-worker": "node ../../scripts/nova-type-check.mjs --project tsconfig.worker.json",
-    "check:types-cli": "node ../../scripts/nova-type-check.mjs --project tsconfig.cli.json",
-    "check:types-config": "node ../../scripts/nova-type-check.mjs --project tsconfig.config.json",
-    "check:test": "vitest run",
     "clean": "node ../../scripts/nova-run-scripts.mjs --parallel 'clean:*'",
     "clean:build": "shx rm -rf ./build"
   },
@@ -99,17 +100,17 @@
     "node": "^22 || ^24"
   },
   "dependencies": {
-    "@cbnventures/nova": "0.25.2",
+    "@cbnventures/nova": "0.27.0",
     "@codesandbox/sandpack-react": "2.20.0",
-    "@docusaurus/plugin-content-blog": "3.10.0",
-    "@docusaurus/plugin-content-docs": "3.10.0",
-    "@docusaurus/plugin-content-pages": "3.10.0",
-    "@docusaurus/plugin-google-tag-manager": "3.10.0",
-    "@docusaurus/plugin-sitemap": "3.10.0",
-    "@docusaurus/plugin-svgr": "3.10.0",
-    "@docusaurus/theme-common": "3.10.0",
-    "@docusaurus/theme-translations": "3.10.0",
-    "@docusaurus/utils-validation": "3.10.0",
+    "@docusaurus/plugin-content-blog": "3.10.2",
+    "@docusaurus/plugin-content-docs": "3.10.2",
+    "@docusaurus/plugin-content-pages": "3.10.2",
+    "@docusaurus/plugin-google-tag-manager": "3.10.2",
+    "@docusaurus/plugin-sitemap": "3.10.2",
+    "@docusaurus/plugin-svgr": "3.10.2",
+    "@docusaurus/theme-common": "3.10.2",
+    "@docusaurus/theme-translations": "3.10.2",
+    "@docusaurus/utils-validation": "3.10.2",
     "@iconify/json": "2.2.488",
     "@iconify/react": "6.0.2",
     "@mdx-js/react": "3.1.1",
@@ -119,26 +120,27 @@
     "lunr": "2.3.9",
     "lunr-languages": "1.14.0",
     "mark.js": "8.11.1",
-    "mermaid": "11.14.0",
+    "mermaid": "11.16.1",
     "nprogress": "0.2.0",
     "prompts": "2.4.2",
     "rtlcss": "4.3.0",
     "shiki": "4.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.10.0",
-    "@docusaurus/types": "3.10.0",
+    "@docusaurus/module-type-aliases": "3.10.2",
+    "@docusaurus/types": "3.10.2",
     "@types/node": "24.9.1",
     "@types/nprogress": "0.2.3",
     "@types/prompts": "2.4.9",
-    "@types/react": "19.2.14",
-    "@types/react-dom": "19.2.3",
-    "eslint": "9.39.3",
+    "@types/react": "19.2.18",
+    "@types/react-dom": "19.2.4",
+    "css-minimizer-webpack-plugin": "5.0.1",
+    "eslint": "9.39.5",
     "glob": "13.0.6",
     "hastscript": "9.0.1",
     "shx": "0.4.0",
-    "typescript": "5.9.3",
-    "vitest": "4.1.3"
+    "typescript": "6.0.3",
+    "vitest": "4.1.11"
   },
   "peerDependencies": {
     "@docusaurus/core": "^3",

package/translations/locales/he/theme-nova.json

@@ -86,6 +86,7 @@
   "theme.blog.post.paginator.navAriaLabel": "ניווט בדף רשומת הבלוג",
   "theme.blog.post.readMore": "קרא עוד",
   "theme.blog.post.readMoreLabel": "קרא עוד על {title}",
+  "theme.blog.post.plurals": "רשומה אחת|שתי רשומות|{count} רשומות",
   "theme.blog.post.readingTime.plurals": "דקת קריאה|{readingTime} דקות קריאה|{readingTime} דקות קריאה",
   "theme.blog.sidebar.ariaLabel": "סרגל הצד של הבלוג",
   "theme.blog.sidebar.authorsLabel": "כותבים",

package/translations/locales/id/theme-nova.json

@@ -86,6 +86,7 @@
   "theme.blog.post.paginator.navAriaLabel": "Navigasi halaman pos blog",
   "theme.blog.post.readMore": "Baca selengkapnya",
   "theme.blog.post.readMoreLabel": "Baca selengkapnya mengenai {title}",
+  "theme.blog.post.plurals": "{count} pos",
   "theme.blog.post.readingTime.plurals": "{readingTime} menit membaca",
   "theme.blog.sidebar.ariaLabel": "Bilah sisi blog",
   "theme.blog.sidebar.authorsLabel": "Penulis",