Generate markdown API docs from JSDoc (#13963)

Author: brophdawg11

.eslintrc

@@ -18,6 +18,58 @@
       "env": {
         "jest/globals": false
       }
+    },
+    {
+      // Only apply JSDoc lint rules to files we auto-generate docs for
+      "files": ["packages/react-router/lib/hooks.tsx"],
+      "plugins": ["jsdoc"],
+      "rules": {
+        "jsdoc/check-access": "error",
+        "jsdoc/check-alignment": "error",
+        "jsdoc/check-param-names": "error",
+        "jsdoc/check-property-names": "error",
+        "jsdoc/check-tag-names": [
+          "error",
+          {
+            "definedTags": ["additionalExamples", "category", "mode"]
+          }
+        ],
+        "jsdoc/no-defaults": "error",
+        "jsdoc/no-multi-asterisks": ["error", { "allowWhitespace": true }],
+        "jsdoc/require-description": "error",
+        "jsdoc/require-param": ["error", { "enableRootFixer": false }],
+        "jsdoc/require-param-description": "error",
+        "jsdoc/require-param-name": "error",
+        "jsdoc/require-returns": "error",
+        "jsdoc/require-returns-check": "error",
+        "jsdoc/require-returns-description": "error",
+        "jsdoc/sort-tags": [
+          "error",
+          {
+            "tagSequence": [
+              {
+                "tags": ["description"]
+              },
+              {
+                "tags": ["example"]
+              },
+              {
+                "tags": ["additionalExamples"]
+              },
+              {
+                "tags": [
+                  "public",
+                  "private",
+                  "category",
+                  "mode",
+                  "param",
+                  "returns"
+                ]
+              }
+            ]
+          }
+        ]
+      }
     }
   ],
   "reportUnusedDisableDirectives": true

docs/api/utils/Location.md

@@ -65,14 +65,17 @@
     "babel-jest": "^29.7.0",
     "babel-plugin-dev-expression": "^0.2.3",
     "chalk": "^4.1.2",
+    "dox": "^1.0.0",
     "eslint": "^8.57.0",
     "eslint-config-react-app": "^7.0.1",
     "eslint-plugin-flowtype": "^8.0.3",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-jsdoc": "^51.3.4",
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "next",
+    "fast-glob": "3.2.11",
     "isbot": "^5.1.11",
     "jest": "^29.6.4",
     "jsonfile": "^6.1.0",