[skip ci] Update generated docs (docs/)

vernak2539 · Dec 12, 2024 · c29309b · c29309b
1 parent 9cf30f6
commit c29309b
Show file tree

Hide file tree

Showing 5 changed files with 135 additions and 171 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -1,41 +1,19 @@
-astro-rehype-relative-markdown-links
-
 # astro-rehype-relative-markdown-links
 
-## Table of contents
-
-### Interfaces
+## Contents
 
-- [CollectionConfig](interfaces/CollectionConfig.md)
-- [Options](interfaces/Options.md)
+* [Interfaces](#interfaces)
+* [Functions](#functions)
 
-### Functions
+## Interfaces
 
-- [default](README.md#default)
+| Interface                                          | Description                 |
+| -------------------------------------------------- | --------------------------- |
+| [CollectionConfig](interfaces/CollectionConfig.md) | Collection specific options |
+| [Options](interfaces/Options.md)                   | General options             |
 
 ## Functions
 
-### default
-
-▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\>
-
-Rehype plugin for Astro to add support for transforming relative links in MD and MDX files into their final page paths.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> |
-| `...parameters` | [(null \| Options)?] |
-
-#### Returns
-
-`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\>
-
-**`See`**
-
-[Options](interfaces/Options.md)
-
-#### Defined in
-
-[src/index.mjs:34](https://github.com/vernak2539/astro-rehype-relative-markdown-links/blob/main/src/index.mjs#L34)
+| Function                        | Description                                                                                                             |
+| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| [default](functions/default.md) | Rehype plugin for Astro to add support for transforming relative links in MD and MDX files into their final page paths. |
diff --git a/docs/functions/default.md b/docs/functions/default.md
@@ -0,0 +1,26 @@
+[astro-rehype-relative-markdown-links](../README.md) / default
+
+# Function: default()
+
+> **default**(`this`, ...`parameters`): `undefined` | `void` | `Transformer`\<`Root`, `Root`>
+
+Rehype plugin for Astro to add support for transforming relative links in MD and MDX files into their final page paths.
+
+## Parameters
+
+| Parameter       | Type                                                                          |
+| --------------- | ----------------------------------------------------------------------------- |
+| `this`          | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`> |
+| ...`parameters` | \[(`null` \| [`Options`](../interfaces/Options.md))?]                         |
+
+## Returns
+
+`undefined` | `void` | `Transformer`\<`Root`, `Root`>
+
+## See
+
+[Options](../interfaces/Options.md)
+
+## Defined in
+
+[src/index.d.ts:11](https://github.com/vernak2539/astro-rehype-relative-markdown-links/blob/main/src/index.d.ts#L11)
diff --git a/docs/interfaces/CollectionConfig.md b/docs/interfaces/CollectionConfig.md
@@ -2,63 +2,51 @@
 
 # Interface: CollectionConfig
 
-## Hierarchy
+Collection specific options
 
-- `input`\<`CollectionConfigSchemaType`\>
+## Contents
 
-  ↳ **`CollectionConfig`**
+* [Extends](#extends)
+* [Properties](#properties)
+  * [base?](#base)
+  * [name?](#name)
 
-## Table of contents
+## Extends
 
-### Properties
-
-- [base](CollectionConfig.md#base)
-- [name](CollectionConfig.md#name)
+* `input`\<`CollectionConfigSchemaType`>
 
 ## Properties
 
-### base
-
-• `Optional` **base**: ``false`` \| ``"name"``
-
-**`Name`**
-
-base
+### base?
 
-**`Description`**
+> `optional` **base**: `false` | `"name"`
 
 Override the top-level [collectionBase](Options.md#collectionbase) option for this collection.
 
 #### Inherited from
 
-z.input.base
+`z.input.base`
 
 #### Defined in
 
-[src/options.mjs:12](https://github.com/vernak2539/astro-rehype-relative-markdown-links/blob/main/src/options.mjs#L12)
-
-___
-
-### name
-
-• `Optional` **name**: `string`
+[src/options.mjs:9](https://github.com/vernak2539/astro-rehype-relative-markdown-links/blob/main/src/options.mjs#L9)
 
-**`Name`**
+***
 
-name
+### name?
 
-**`Description`**
+> `optional` **name**: `string`
 
 Override the name of the collection from disk.
 
-Use this option when your collection page path does not correspond to the name of the collection on disk (ex. `src/content/docs/reference.md` resolves to a page path of /my-docs/reference).
+Use this option when your collection page path does not correspond to the name of the collection on disk (ex. `src/content/docs/reference.md` resolves to a page path of `/my-docs/reference`).
 
 When not specified, the name of the collection from disk will be used where applicable.
 
 #### Inherited from
 
-z.input.name
+`z.input.name`
 
 #### Defined in
 
-[src/options.mjs:23](https://github.com/vernak2539/astro-rehype-relative-markdown-links/blob/main/src/options.mjs#L23)
+[src/options.mjs:17](https://github.com/vernak2539/astro-rehype-relative-markdown-links/blob/main/src/options.mjs#L17)