docs: generate api reference from declaration file

- generate api reference with microsoft api-extractor
- add eslint plugin for tsdoc

Author: Ffloriel

.eslintrc.js

@@ -5,10 +5,13 @@ module.exports = {
   },
   root: true,
   parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint"],
+  plugins: ["@typescript-eslint", "eslint-plugin-tsdoc"],
   extends: [
     "eslint:recommended",
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
   ],
+  rules: {
+    "tsdoc/syntax": "warn",
+  }
 };

.gitignore

@@ -1,3 +1,4 @@
+docs/api-reference/
 packages/*/lib/*
 packages/grunt-purgecss/tasks/purgecss.js
 docs/.vuepress/dist/

api-extractor.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/packages/purgecss/lib/purgecss.d.ts",
+  "bundledPackages": [],
+  "compiler": {},
+  "apiReport": {
+    "enabled": false
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "<projectFolder>/docs/.vuepress/.temp/api-reference/<unscopedPackageName>.api.json"
+  },
+  "dtsRollup": {
+    "enabled": false
+  },
+  "tsdocMetadata": {
+    "enabled": false
+  },
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      },
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      }
+    },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    }
+  }
+}

docs/.vuepress/config.ts

@@ -85,6 +85,12 @@ export default defineUserConfig<DefaultThemeOptions>({
   themeConfig: {
     logo: "https://i.imgur.com/UEiUiJ0.png",
     repo: "FullHuman/purgecss",
+    navbar: [
+      {
+        text: "API Reference",
+        link: "/api-reference/",
+      },
+    ],
     sidebar: {
       "/": [
         {