@docusaurus/plugin-content-pages 2.0.0-beta.15d451942 → 2.0.0-beta.16

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

@@ -5,24 +5,63 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+declare module '@docusaurus/plugin-content-pages' {
+  import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
+
+  export type PluginOptions = RemarkAndRehypePluginOptions & {
+    id?: string;
+    path: string;
+    routeBasePath: string;
+    include: string[];
+    exclude: string[];
+    mdxPageComponent: string;
+    admonitions: Record<string, unknown>;
+  };
+
+  export type Options = Partial<PluginOptions>;
+
+  export type FrontMatter = {
+    readonly title?: string;
+    readonly description?: string;
+    readonly wrapperClassName?: string;
+    readonly hide_table_of_contents?: string;
+    readonly toc_min_heading_level?: number;
+    readonly toc_max_heading_level?: number;
+  };
+
+  export type JSXPageMetadata = {
+    type: 'jsx';
+    permalink: string;
+    source: string;
+  };
+
+  export type MDXPageMetadata = {
+    type: 'mdx';
+    permalink: string;
+    source: string;
+    frontMatter: FrontMatter & Record<string, unknown>;
+    title?: string;
+    description?: string;
+  };
+
+  export type Metadata = JSXPageMetadata | MDXPageMetadata;
+}
+
 declare module '@theme/MDXPage' {
   import type {TOCItem} from '@docusaurus/types';
+  import type {
+    MDXPageMetadata,
+    FrontMatter,
+  } from '@docusaurus/plugin-content-pages';
 
-  export type Props = {
+  export interface Props {
     readonly content: {
-      readonly frontMatter: {
-        readonly title: string;
-        readonly description: string;
-        readonly wrapperClassName?: string;
-        // eslint-disable-next-line camelcase
-        readonly hide_table_of_contents?: string;
-      };
-      readonly metadata: {readonly permalink: string};
+      readonly frontMatter: FrontMatter;
+      readonly metadata: MDXPageMetadata;
       readonly toc: readonly TOCItem[];
       (): JSX.Element;
     };
-  };
+  }
 
-  const MDXPage: (props: Props) => JSX.Element;
-  export default MDXPage;
+  export default function MDXPage(props: Props): JSX.Element;
 }

package/src/pluginOptionSchema.ts

@@ -4,29 +4,27 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import {PluginOptions} from './types';
+
+import type {PluginOptions} from '@docusaurus/plugin-content-pages';
 import {
   Joi,
   RemarkPluginsSchema,
   RehypePluginsSchema,
   AdmonitionsSchema,
 } from '@docusaurus/utils-validation';
+import {GlobExcludeDefault} from '@docusaurus/utils';
 
 export const DEFAULT_OPTIONS: PluginOptions = {
   path: 'src/pages', // Path to data on filesystem, relative to site dir.
   routeBasePath: '/', // URL Route.
   include: ['**/*.{js,jsx,ts,tsx,md,mdx}'], // Extensions to include.
+  exclude: GlobExcludeDefault,
   mdxPageComponent: '@theme/MDXPage',
   remarkPlugins: [],
   rehypePlugins: [],
   beforeDefaultRehypePlugins: [],
   beforeDefaultRemarkPlugins: [],
   admonitions: {},
-  exclude: [
-    '**/_*.{js,jsx,ts,tsx,md,mdx}',
-    '**/*.test.{js,ts}',
-    '**/__tests__/**',
-  ],
 };
 
 export const PluginOptionSchema = Joi.object({

package/src/types.ts

@@ -5,31 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
-
-export interface PluginOptions extends RemarkAndRehypePluginOptions {
-  id?: string;
-  path: string;
-  routeBasePath: string;
-  include: string[];
-  exclude: string[];
-  mdxPageComponent: string;
-  admonitions: Record<string, unknown>;
-}
-
-export type JSXPageMetadata = {
-  type: 'jsx';
-  permalink: string;
-  source: string;
-};
-
-export type MDXPageMetadata = {
-  type: 'mdx';
-  permalink: string;
-  source: string;
-};
-
-export type Metadata = JSXPageMetadata | MDXPageMetadata;
+import type {Metadata} from '@docusaurus/plugin-content-pages';
 
 export type LoadedContent = Metadata[];