@docusaurus/plugin-content-docs 0.0.0-4466 → 0.0.0-4484

package/lib/docs.js

@@ -66,7 +66,7 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
     const frontMatter = (0, docFrontMatter_1.validateDocFrontMatter)(unsafeFrontMatter);
     const { custom_edit_url: customEditURL, 
     // Strip number prefixes by default (01-MyFolder/01-MyDoc.md => MyFolder/MyDoc) by default,
-    // but allow to disable this behavior with frontmatter
+    // but allow to disable this behavior with front matter
     parse_number_prefixes: parseNumberPrefixes = true, } = frontMatter;
     // ex: api/plugins/myDoc -> myDoc
     // ex: myDoc -> myDoc
@@ -81,7 +81,7 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
     if (baseID.includes('/')) {
         throw new Error(`Document id "${baseID}" cannot include slash.`);
     }
-    // For autogenerated sidebars, sidebar position can come from filename number prefix or frontmatter
+    // For autogenerated sidebars, sidebar position can come from filename number prefix or front matter
     const sidebarPosition = (_b = frontMatter.sidebar_position) !== null && _b !== void 0 ? _b : numberPrefix;
     // TODO legacy retrocompatibility
     // The same doc in 2 distinct version could keep the same id,
@@ -90,7 +90,7 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
         ? undefined
         : `version-${versionMetadata.versionName}`;
     // TODO legacy retrocompatibility
-    // I think it's bad to affect the frontmatter id with the dirname?
+    // I think it's bad to affect the front matter id with the dirname?
     function computeDirNameIdPrefix() {
         if (sourceDirName === '.') {
             return undefined;
@@ -110,7 +110,7 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
         baseID,
         source,
         sourceDirName,
-        frontmatterSlug: frontMatter.slug,
+        frontMatterSlug: frontMatter.slug,
         stripDirNumberPrefixes: parseNumberPrefixes,
         numberPrefixParser: options.numberPrefixParser,
     });

package/lib/slug.d.ts

@@ -6,9 +6,9 @@
  */
 import type { DocMetadataBase } from './types';
 import type { NumberPrefixParser } from '@docusaurus/plugin-content-docs';
-export default function getSlug({ baseID, frontmatterSlug, source, sourceDirName, stripDirNumberPrefixes, numberPrefixParser, }: {
+export default function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumberPrefixes, numberPrefixParser, }: {
     baseID: string;
-    frontmatterSlug?: string;
+    frontMatterSlug?: string;
     source: DocMetadataBase['slug'];
     sourceDirName: DocMetadataBase['sourceDirName'];
     stripDirNumberPrefixes?: boolean;

package/lib/slug.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@docusaurus/utils");
 const numberPrefix_1 = require("./numberPrefix");
 const docs_1 = require("./docs");
-function getSlug({ baseID, frontmatterSlug, source, sourceDirName, stripDirNumberPrefixes = true, numberPrefixParser = numberPrefix_1.DefaultNumberPrefixParser, }) {
+function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumberPrefixes = true, numberPrefixParser = numberPrefix_1.DefaultNumberPrefixParser, }) {
     function getDirNameSlug() {
         const dirNameStripped = stripDirNumberPrefixes
             ? (0, numberPrefix_1.stripPathNumberPrefixes)(sourceDirName, numberPrefixParser)
@@ -20,15 +20,15 @@ function getSlug({ baseID, frontmatterSlug, source, sourceDirName, stripDirNumbe
         return resolveDirname;
     }
     function computeSlug() {
-        if (frontmatterSlug === null || frontmatterSlug === void 0 ? void 0 : frontmatterSlug.startsWith('/')) {
-            return frontmatterSlug;
+        if (frontMatterSlug === null || frontMatterSlug === void 0 ? void 0 : frontMatterSlug.startsWith('/')) {
+            return frontMatterSlug;
         }
         else {
             const dirNameSlug = getDirNameSlug();
-            if (!frontmatterSlug && (0, docs_1.isConventionalDocIndex)({ source, sourceDirName })) {
+            if (!frontMatterSlug && (0, docs_1.isConventionalDocIndex)({ source, sourceDirName })) {
                 return dirNameSlug;
             }
-            const baseSlug = frontmatterSlug || baseID;
+            const baseSlug = frontMatterSlug || baseID;
             return (0, utils_1.resolvePathname)(baseSlug, getDirNameSlug());
         }
     }
@@ -36,8 +36,8 @@ function getSlug({ baseID, frontmatterSlug, source, sourceDirName, stripDirNumbe
         if (!(0, utils_1.isValidPathname)(slug)) {
             throw new Error(`We couldn't compute a valid slug for document with id "${baseID}" in "${sourceDirName}" directory.
 The slug we computed looks invalid: ${slug}.
-Maybe your slug frontmatter is incorrect or you use weird chars in the file path?
-By using the slug frontmatter, you should be able to fix this error, by using the slug of your choice:
+Maybe your slug front matter is incorrect or you use weird chars in the file path?
+By using the slug front matter, you should be able to fix this error, by using the slug of your choice:
 
 Example =>
 ---

package/lib/translations.js

@@ -33,7 +33,7 @@ function getNormalizedSidebarName({ versionName, sidebarName, }) {
 }
 /*
 // Do we need to translate doc metadata?
-// It seems translating frontmatter labels is good enough
+// It seems translating front matter labels is good enough
 function getDocTranslations(doc: DocMetadata): TranslationFileContent {
   return {
     [`${doc.unversionedId}.title`]: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4466",
+  "version": "0.0.0-4484",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -22,11 +22,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4466",
-    "@docusaurus/logger": "0.0.0-4466",
-    "@docusaurus/mdx-loader": "0.0.0-4466",
-    "@docusaurus/utils": "0.0.0-4466",
-    "@docusaurus/utils-validation": "0.0.0-4466",
+    "@docusaurus/core": "0.0.0-4484",
+    "@docusaurus/logger": "0.0.0-4484",
+    "@docusaurus/mdx-loader": "0.0.0-4484",
+    "@docusaurus/utils": "0.0.0-4484",
+    "@docusaurus/utils-validation": "0.0.0-4484",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.0",
     "import-fresh": "^3.2.2",
@@ -39,8 +39,8 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4466",
-    "@docusaurus/types": "0.0.0-4466",
+    "@docusaurus/module-type-aliases": "0.0.0-4484",
+    "@docusaurus/types": "0.0.0-4484",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -55,5 +55,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "e610ca3c26f1f080d90ac0cf02e73e556142dd7f"
+  "gitHead": "ae60bd68f83e8063d4467fc31fa2c42432a5deeb"
 }

package/src/docFrontMatter.ts

@@ -6,7 +6,7 @@
  */
 
 import {
-  JoiFrontMatter as Joi, // Custom instance for frontmatter
+  JoiFrontMatter as Joi, // Custom instance for front matter
   URISchema,
   FrontMatterTagsSchema,
   FrontMatterTOCHeadingLevels,

package/src/docs.ts

@@ -138,7 +138,7 @@ function doProcessDocMetadata({
     custom_edit_url: customEditURL,
 
     // Strip number prefixes by default (01-MyFolder/01-MyDoc.md => MyFolder/MyDoc) by default,
-    // but allow to disable this behavior with frontmatter
+    // but allow to disable this behavior with front matter
     parse_number_prefixes: parseNumberPrefixes = true,
   } = frontMatter;
 
@@ -162,7 +162,7 @@ function doProcessDocMetadata({
     throw new Error(`Document id "${baseID}" cannot include slash.`);
   }
 
-  // For autogenerated sidebars, sidebar position can come from filename number prefix or frontmatter
+  // For autogenerated sidebars, sidebar position can come from filename number prefix or front matter
   const sidebarPosition: number | undefined =
     frontMatter.sidebar_position ?? numberPrefix;
 
@@ -175,7 +175,7 @@ function doProcessDocMetadata({
       : `version-${versionMetadata.versionName}`;
 
   // TODO legacy retrocompatibility
-  // I think it's bad to affect the frontmatter id with the dirname?
+  // I think it's bad to affect the front matter id with the dirname?
   function computeDirNameIdPrefix() {
     if (sourceDirName === '.') {
       return undefined;
@@ -198,7 +198,7 @@ function doProcessDocMetadata({
     baseID,
     source,
     sourceDirName,
-    frontmatterSlug: frontMatter.slug,
+    frontMatterSlug: frontMatter.slug,
     stripDirNumberPrefixes: parseNumberPrefixes,
     numberPrefixParser: options.numberPrefixParser,
   });

package/src/slug.ts

@@ -21,14 +21,14 @@ import type {NumberPrefixParser} from '@docusaurus/plugin-content-docs';
 
 export default function getSlug({
   baseID,
-  frontmatterSlug,
+  frontMatterSlug,
   source,
   sourceDirName,
   stripDirNumberPrefixes = true,
   numberPrefixParser = DefaultNumberPrefixParser,
 }: {
   baseID: string;
-  frontmatterSlug?: string;
+  frontMatterSlug?: string;
   source: DocMetadataBase['slug'];
   sourceDirName: DocMetadataBase['sourceDirName'];
   stripDirNumberPrefixes?: boolean;
@@ -46,14 +46,14 @@ export default function getSlug({
   }
 
   function computeSlug(): string {
-    if (frontmatterSlug?.startsWith('/')) {
-      return frontmatterSlug;
+    if (frontMatterSlug?.startsWith('/')) {
+      return frontMatterSlug;
     } else {
       const dirNameSlug = getDirNameSlug();
-      if (!frontmatterSlug && isConventionalDocIndex({source, sourceDirName})) {
+      if (!frontMatterSlug && isConventionalDocIndex({source, sourceDirName})) {
         return dirNameSlug;
       }
-      const baseSlug = frontmatterSlug || baseID;
+      const baseSlug = frontMatterSlug || baseID;
       return resolvePathname(baseSlug, getDirNameSlug());
     }
   }
@@ -63,8 +63,8 @@ export default function getSlug({
       throw new Error(
         `We couldn't compute a valid slug for document with id "${baseID}" in "${sourceDirName}" directory.
 The slug we computed looks invalid: ${slug}.
-Maybe your slug frontmatter is incorrect or you use weird chars in the file path?
-By using the slug frontmatter, you should be able to fix this error, by using the slug of your choice:
+Maybe your slug front matter is incorrect or you use weird chars in the file path?
+By using the slug front matter, you should be able to fix this error, by using the slug of your choice:
 
 Example =>
 ---

package/src/translations.ts

@@ -57,7 +57,7 @@ function getNormalizedSidebarName({
 
 /*
 // Do we need to translate doc metadata?
-// It seems translating frontmatter labels is good enough
+// It seems translating front matter labels is good enough
 function getDocTranslations(doc: DocMetadata): TranslationFileContent {
   return {
     [`${doc.unversionedId}.title`]: {