@docusaurus/plugin-content-docs 0.0.0-5089 → 0.0.0-5093

package/lib/cli.js

@@ -50,12 +50,14 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
         logger_1.default.info `Versioned docs will be created for the following locales: name=${i18n.locales}`;
     }
     await Promise.all(i18n.locales.map(async (locale) => {
+        // TODO duplicated logic from core, so duplicate comment as well: we need
+        // to support customization per-locale in the future
+        const localizationDir = path_1.default.resolve(siteDir, i18n.path, locale);
         // Copy docs files.
         const docsDir = locale === i18n.defaultLocale
             ? path_1.default.resolve(siteDir, docsPath)
             : (0, files_1.getDocsDirPathLocalized)({
-                siteDir,
-                locale,
+                localizationDir,
                 pluginId,
                 versionName: constants_1.CURRENT_VERSION_NAME,
             });
@@ -72,8 +74,7 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
         const newVersionDir = locale === i18n.defaultLocale
             ? (0, files_1.getVersionDocsDirPath)(siteDir, pluginId, version)
             : (0, files_1.getDocsDirPathLocalized)({
-                siteDir,
-                locale,
+                localizationDir,
                 pluginId,
                 versionName: version,
             });

package/lib/index.js

@@ -228,6 +228,7 @@ async function pluginContentDocs(context, options) {
                         {
                             loader: require.resolve('@docusaurus/mdx-loader'),
                             options: {
+                                admonitions: options.admonitions,
                                 remarkPlugins,
                                 rehypePlugins,
                                 beforeDefaultRehypePlugins,

package/lib/options.js

@@ -11,7 +11,6 @@ const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
-const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
 const generator_1 = require("./sidebars/generator");
 const numberPrefix_1 = require("./numberPrefix");
 exports.DEFAULT_OPTIONS = {
@@ -33,7 +32,7 @@ exports.DEFAULT_OPTIONS = {
     beforeDefaultRehypePlugins: [],
     showLastUpdateTime: false,
     showLastUpdateAuthor: false,
-    admonitions: {},
+    admonitions: true,
     includeCurrentVersion: true,
     disableVersioning: false,
     lastVersion: undefined,
@@ -90,9 +89,7 @@ const OptionsSchema = utils_validation_1.Joi.object({
     rehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.rehypePlugins),
     beforeDefaultRemarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRemarkPlugins),
     beforeDefaultRehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRehypePlugins),
-    admonitions: utils_validation_1.Joi.alternatives()
-        .try(utils_validation_1.AdmonitionsSchema, utils_validation_1.Joi.boolean().invalid(true))
-        .default(exports.DEFAULT_OPTIONS.admonitions),
+    admonitions: utils_validation_1.AdmonitionsSchema.default(exports.DEFAULT_OPTIONS.admonitions),
     showLastUpdateTime: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.showLastUpdateTime),
     showLastUpdateAuthor: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.showLastUpdateAuthor),
     includeCurrentVersion: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.includeCurrentVersion),
@@ -123,11 +120,6 @@ function validateOptions({ validate, options: userOptions, }) {
         }
     }
     const normalizedOptions = validate(OptionsSchema, options);
-    if (normalizedOptions.admonitions) {
-        normalizedOptions.remarkPlugins = normalizedOptions.remarkPlugins.concat([
-            [remark_admonitions_1.default, normalizedOptions.admonitions],
-        ]);
-    }
     return normalizedOptions;
 }
 exports.validateOptions = validateOptions;

package/lib/versions/files.d.ts

@@ -10,9 +10,8 @@ import type { VersionContext } from './index';
 export declare function getVersionDocsDirPath(siteDir: string, pluginId: string, versionName: string): string;
 /** `[siteDir]/community_versioned_sidebars/version-1.0.0-sidebars.json` */
 export declare function getVersionSidebarsPath(siteDir: string, pluginId: string, versionName: string): string;
-export declare function getDocsDirPathLocalized({ siteDir, locale, pluginId, versionName, }: {
-    siteDir: string;
-    locale: string;
+export declare function getDocsDirPathLocalized({ localizationDir, pluginId, versionName, }: {
+    localizationDir: string;
     pluginId: string;
     versionName: string;
 }): string;

package/lib/versions/files.js

@@ -29,10 +29,9 @@ function getVersionSidebarsPath(siteDir, pluginId, versionName) {
     return path_1.default.join(siteDir, addPluginIdPrefix(constants_1.VERSIONED_SIDEBARS_DIR, pluginId), `version-${versionName}-sidebars.json`);
 }
 exports.getVersionSidebarsPath = getVersionSidebarsPath;
-function getDocsDirPathLocalized({ siteDir, locale, pluginId, versionName, }) {
+function getDocsDirPathLocalized({ localizationDir, pluginId, versionName, }) {
     return (0, utils_1.getPluginI18nPath)({
-        siteDir,
-        locale,
+        localizationDir,
         pluginName: 'docusaurus-plugin-content-docs',
         pluginId,
         subPaths: [
@@ -110,8 +109,7 @@ exports.readVersionNames = readVersionNames;
 async function getVersionMetadataPaths({ versionName, context, options, }) {
     const isCurrent = versionName === constants_1.CURRENT_VERSION_NAME;
     const contentPathLocalized = getDocsDirPathLocalized({
-        siteDir: context.siteDir,
-        locale: context.i18n.currentLocale,
+        localizationDir: context.localizationDir,
         pluginId: options.id,
         versionName,
     });

package/lib/versions/index.js

@@ -22,8 +22,7 @@ function getVersionEditUrls({ contentPath, contentPathLocalized, context, option
     const editDirPath = options.editCurrentVersion ? options.path : contentPath;
     const editDirPathLocalized = options.editCurrentVersion
         ? (0, files_1.getDocsDirPathLocalized)({
-            siteDir: context.siteDir,
-            locale: context.i18n.currentLocale,
+            localizationDir: context.localizationDir,
             versionName: constants_1.CURRENT_VERSION_NAME,
             pluginId: options.id,
         })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-5089",
+  "version": "0.0.0-5093",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -25,20 +25,19 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5089",
-    "@docusaurus/logger": "0.0.0-5089",
-    "@docusaurus/mdx-loader": "0.0.0-5089",
-    "@docusaurus/module-type-aliases": "0.0.0-5089",
-    "@docusaurus/types": "0.0.0-5089",
-    "@docusaurus/utils": "0.0.0-5089",
-    "@docusaurus/utils-validation": "0.0.0-5089",
+    "@docusaurus/core": "0.0.0-5093",
+    "@docusaurus/logger": "0.0.0-5093",
+    "@docusaurus/mdx-loader": "0.0.0-5093",
+    "@docusaurus/module-type-aliases": "0.0.0-5093",
+    "@docusaurus/types": "0.0.0-5093",
+    "@docusaurus/utils": "0.0.0-5093",
+    "@docusaurus/utils-validation": "0.0.0-5093",
     "@types/react-router-config": "^5.0.6",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.1.0",
     "import-fresh": "^3.3.0",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
-    "remark-admonitions": "^1.2.1",
     "tslib": "^2.4.0",
     "utility-types": "^3.10.0",
     "webpack": "^5.72.1"
@@ -59,5 +58,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "f03215790788b609224a7d79e123fdfb3ecdb717"
+  "gitHead": "2aa3114f2c53ba37b785f22ac723059c7a4a75be"
 }

package/src/cli.ts

@@ -85,13 +85,15 @@ export async function cliDocsVersionCommand(
 
   await Promise.all(
     i18n.locales.map(async (locale) => {
+      // TODO duplicated logic from core, so duplicate comment as well: we need
+      // to support customization per-locale in the future
+      const localizationDir = path.resolve(siteDir, i18n.path, locale);
       // Copy docs files.
       const docsDir =
         locale === i18n.defaultLocale
           ? path.resolve(siteDir, docsPath)
           : getDocsDirPathLocalized({
-              siteDir,
-              locale,
+              localizationDir,
               pluginId,
               versionName: CURRENT_VERSION_NAME,
             });
@@ -114,8 +116,7 @@ export async function cliDocsVersionCommand(
         locale === i18n.defaultLocale
           ? getVersionDocsDirPath(siteDir, pluginId, version)
           : getDocsDirPathLocalized({
-              siteDir,
-              locale,
+              localizationDir,
               pluginId,
               versionName: version,
             });

package/src/index.ts

@@ -352,6 +352,7 @@ export default async function pluginContentDocs(
             {
               loader: require.resolve('@docusaurus/mdx-loader'),
               options: {
+                admonitions: options.admonitions,
                 remarkPlugins,
                 rehypePlugins,
                 beforeDefaultRehypePlugins,

package/src/options.ts

@@ -14,7 +14,6 @@ import {
   URISchema,
 } from '@docusaurus/utils-validation';
 import {GlobExcludeDefault} from '@docusaurus/utils';
-import admonitions from 'remark-admonitions';
 import {DefaultSidebarItemsGenerator} from './sidebars/generator';
 import {
   DefaultNumberPrefixParser,
@@ -42,7 +41,7 @@ export const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'> = {
   beforeDefaultRehypePlugins: [],
   showLastUpdateTime: false,
   showLastUpdateAuthor: false,
-  admonitions: {},
+  admonitions: true,
   includeCurrentVersion: true,
   disableVersioning: false,
   lastVersion: undefined,
@@ -123,9 +122,7 @@ const OptionsSchema = Joi.object<PluginOptions>({
   beforeDefaultRehypePlugins: RehypePluginsSchema.default(
     DEFAULT_OPTIONS.beforeDefaultRehypePlugins,
   ),
-  admonitions: Joi.alternatives()
-    .try(AdmonitionsSchema, Joi.boolean().invalid(true))
-    .default(DEFAULT_OPTIONS.admonitions),
+  admonitions: AdmonitionsSchema.default(DEFAULT_OPTIONS.admonitions),
   showLastUpdateTime: Joi.bool().default(DEFAULT_OPTIONS.showLastUpdateTime),
   showLastUpdateAuthor: Joi.bool().default(
     DEFAULT_OPTIONS.showLastUpdateAuthor,
@@ -167,11 +164,5 @@ export function validateOptions({
 
   const normalizedOptions = validate(OptionsSchema, options);
 
-  if (normalizedOptions.admonitions) {
-    normalizedOptions.remarkPlugins = normalizedOptions.remarkPlugins.concat([
-      [admonitions, normalizedOptions.admonitions],
-    ]);
-  }
-
   return normalizedOptions;
 }

package/src/plugin-content-docs.d.ts

@@ -206,7 +206,6 @@ declare module '@docusaurus/plugin-content-docs' {
       docTagsListComponent: string;
       /** Root component of the generated category index page. */
       docCategoryGeneratedIndexComponent: string;
-      admonitions: {[key: string]: unknown};
       sidebarItemsGenerator: import('./sidebars/types').SidebarItemsGeneratorOption;
       /**
        * URL route for the tags section of your doc version. Will be appended to

package/src/versions/files.ts

@@ -55,19 +55,16 @@ export function getVersionSidebarsPath(
 }
 
 export function getDocsDirPathLocalized({
-  siteDir,
-  locale,
+  localizationDir,
   pluginId,
   versionName,
 }: {
-  siteDir: string;
-  locale: string;
+  localizationDir: string;
   pluginId: string;
   versionName: string;
 }): string {
   return getPluginI18nPath({
-    siteDir,
-    locale,
+    localizationDir,
     pluginName: 'docusaurus-plugin-content-docs',
     pluginId,
     subPaths: [
@@ -175,8 +172,7 @@ export async function getVersionMetadataPaths({
 > {
   const isCurrent = versionName === CURRENT_VERSION_NAME;
   const contentPathLocalized = getDocsDirPathLocalized({
-    siteDir: context.siteDir,
-    locale: context.i18n.currentLocale,
+    localizationDir: context.localizationDir,
     pluginId: options.id,
     versionName,
   });

package/src/versions/index.ts

@@ -49,8 +49,7 @@ function getVersionEditUrls({
   const editDirPath = options.editCurrentVersion ? options.path : contentPath;
   const editDirPathLocalized = options.editCurrentVersion
     ? getDocsDirPathLocalized({
-        siteDir: context.siteDir,
-        locale: context.i18n.currentLocale,
+        localizationDir: context.localizationDir,
         versionName: CURRENT_VERSION_NAME,
         pluginId: options.id,
       })

package/src/deps.d.ts

@@ -1,13 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-declare module 'remark-admonitions' {
-  type Options = {[key: string]: unknown};
-
-  const plugin: (options?: Options) => void;
-  export = plugin;
-}