docs: use typedoc-plugin-md to generate markdown files (#151)

Author: ocavue

.changeset/config.json

@@ -7,5 +7,5 @@
   "access": "public",
   "baseBranch": "master",
   "updateInternalDependencies": "patch",
-  "ignore": ["aria-ui-typedoc-plugin", "aria-ui-website"]
+  "ignore": ["aria-ui-website"]
 }

config/typedoc-base.json

@@ -1,8 +1,7 @@
 // https://typedoc.org/options/
 {
   "$schema": "https://typedoc.org/schema.json",
-  "plugin": ["typedoc-plugin-markdown", "aria-ui-typedoc-plugin"],
-  "theme": "custom-theme",
+  "plugin": ["typedoc-plugin-md"],
   "githubPages": false,
   "treatWarningsAsErrors": true,
   "cleanOutputDir": true,
@@ -35,26 +34,5 @@
     "@beta": false
   },
 
-  "readme": "none",
-
-  // https://www.typedoc-plugin-markdown.org/docs/options
-  "hideBreadcrumbs": true,
-  "hidePageHeader": true,
-  "enumMembersFormat": "table",
-  "propertiesFormat": "table",
-  "outputFileStrategy": "modules",
-  "useCodeBlocks": true,
-  "expandParameters": true,
-  "textContentMappings": {
-    "kind.typeParameter.plural": "TYPEDOC_REMOVE_PLACEHOLDER",
-    "kind.constructor.plural": "TYPEDOC_REMOVE_PLACEHOLDER",
-    "kind.property.plural": "TYPEDOC_REMOVE_PLACEHOLDER"
-  },
-  "tableColumnSettings": {
-    "hideDefaults": false,
-    "hideInherited": true,
-    "hideOverrides": true,
-    "hideSources": true,
-    "hideValues": false
-  }
+  "readme": "none"
 }

package.json

@@ -33,7 +33,6 @@
     "@testing-library/dom": "^10.4.0",
     "@testing-library/jest-dom": "^6.5.0",
     "@types/bun": "^1.1.8",
-    "aria-ui-typedoc-plugin": "workspace:*",
     "change-case": "5.4.4",
     "comment-json": "4.2.5",
     "eslint": "^9.9.1",
@@ -44,7 +43,7 @@
     "prettier-plugin-astro": "^0.14.1",
     "turbo": "2.1.1",
     "typedoc": "0.26.7",
-    "typedoc-plugin-markdown": "4.2.8",
+    "typedoc-plugin-md": "^0.1.0",
     "typescript": "^5.5.4",
     "vitest": "^2.0.5"
   },

packages/collection/README.md

@@ -1,93 +1,147 @@
 # @aria-ui/collection
 
-## Classes
+## API
 
-### Collection
+### Collection <a id="collection" href="#collection">#</a>
 
-#### Constructors
+<dl>
+
+<dt>
+
+`constructor`
+
+</dt>
+
+<dd>
 
 ```ts
-new Collection(items: Iterable<HTMLElement>, loop: boolean): Collection
+new Collection(items: Iterable<HTMLElement>, loop: boolean)
 ```
 
-#### Properties
+</dd>
 
-| Property | Modifier   | Type      | Default value |
-| -------- | ---------- | --------- | ------------- |
-| `loop`   | `readonly` | `boolean` | `true`        |
+<dt>
 
-#### Methods
+`loop`
 
-##### first()
+</dt>
 
-```ts
-first(): null | string
-```
+<dd>
+
+**Type**: `boolean`
+
+</dd>
+
+<dt>
 
-Returns the first enabled value.
+`first`
 
-##### getElement()
+</dt>
+
+<dd>
 
 ```ts
-getElement(value: string): null | HTMLElement
+const first: () => null | string;
 ```
 
-Finds an element from its value.
+</dd>
+
+<dt>
+
+`getElement`
 
-##### getValues()
+</dt>
+
+<dd>
 
 ```ts
-getValues(): string[]
+const getElement: (value: string) => null | HTMLElement;
 ```
 
-Returns all values.
+</dd>
+
+<dt>
 
-##### last()
+`getValues`
+
+</dt>
+
+<dd>
 
 ```ts
-last(): null | string
+const getValues: () => string[];
 ```
 
-Returns the last enabled value.
+</dd>
+
+<dt>
+
+`last`
 
-##### next()
+</dt>
+
+<dd>
 
 ```ts
-next(value: null | string): null | string
+const last: () => null | string;
 ```
 
-Returns the next enabled value.
+</dd>
+
+<dt>
+
+`next`
 
-##### prev()
+</dt>
+
+<dd>
 
 ```ts
-prev(value: null | string): null | string
+const next: (value: null | string) => null | string;
 ```
 
-Returns the previous enabled value.
+</dd>
+
+<dt>
 
-##### size()
+`prev`
+
+</dt>
+
+<dd>
 
 ```ts
-size(): number
+const prev: (value: null | string) => null | string;
 ```
 
-## Type Aliases
+</dd>
+
+<dt>
+
+`size`
 
-### ItemFilter()
+</dt>
+
+<dd>
 
 ```ts
-type ItemFilter: (options: object) => boolean;
+const size: () => number;
 ```
 
+</dd>
+
+</dl>
+
+### ItemFilter <a id="item-filter" href="#item-filter">#</a>
+
 The filter function to determine if an item should be shown in the collection.
 
-## Functions
+**Type**: `(options: Object) => boolean`
 
-### defaultItemFilter()
+### defaultItemFilter <a id="default-item-filter" href="#default-item-filter">#</a>
+
+A simple case-insensitive substring match filter.
 
 ```ts
-function defaultItemFilter(options: object): boolean;
+function defaultItemFilter(options: Object): boolean;
 ```
-
-A simple case-insensitive substring match filter.