chore(docs): add typedoc-generated API reference docs

Author: charles4221

.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: API Reference Documentation
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'API Reference Documentation'
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js 22.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 22.x
+          cache: 'npm'
+
+      - name: Install Node Dependencies
+        run: npm ci
+
+      - name: Build API Reference Documentation
+        run: npm run build:docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload Artifacts
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs/dist'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -3,5 +3,6 @@ node_modules
 bin/act
 fortawesome-react-fontawesome-*.tgz
 dist/
+docs/dist/
 coverage/
 .env

.prettierignore

@@ -1,3 +1,4 @@
 /dist
+/docs/dist
 /coverage
 CHANGELOG.md

.tool-versions

@@ -1 +1 @@
-nodejs 22.21.1
+nodejs 22.22.1

.vscode/settings.json

@@ -5,9 +5,9 @@
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
   },
-  "javascript.format.enable": false, // formatting is handled by prettier
-  "javascript.validate.enable": false, // validation is handled by typescript and eslint
-  "typescript.tsdk": "node_modules/typescript/lib", // ensure VSCode uses the local TypeScript version
+  "js/ts.format.enabled": false, // formatting is handled by prettier
+  "js/ts.validate.enabled": false, // validation is handled by typescript and eslint
+  "js/ts.tsdk.path": "node_modules/typescript/lib", // ensure VSCode uses the local TypeScript version
   // Language-specific Overrides
   "[javascript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"

docs/src/API-Reference-Readme.md

@@ -0,0 +1,22 @@
+# Overview <i color="#428fdc" class="fa-solid fa-font-awesome" aria-label="FontAwesome"></i>
+
+This documentation serves purely as an API Reference for the modules contained in the latest version of the `react-fontawesome` library.
+
+It uses [TypeDoc](https://typedoc.org/) to generate documentation from the library's source code and code comments, giving us an overview of all the modules, interfaces, variables and functions available in this library, as well as descriptions of each prop available on the React component, what those props do, and examples of how to use them.
+
+It is assumed if you are reading this API Reference that you're already familiar with the concepts and usage of FontAwesome and React.
+
+For more detailed documentation on how to use FontAwesome with React in general, or how to use the `react-fontawesome` library, see here:
+
+- [FontAwesome Documentation - Use With React](https://docs.fontawesome.com/web/use-with/react)
+- [react-fontawesome on GitHub](https://github.com/FortAwesome/react-fontawesome)
+
+## How to use this reference
+
+In the side-bar menu, the top level items are the two key module entry points that are exported by the library:
+
+- `index` - includes anything exported via the main entry point
+  - e.g. `import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'`
+- `components/rsc/CustomPrefixProvider` - special module for using custom FA prefixes with server-side rendering
+  - e.g. `import { CustomPrefixProvider } from '@fortawesome/react-fontawesome/components/rsc/CustomPrefixProvider'`
+- `<internal>` - refers to types and interfaces that are used internally within the package but are not exported by the package to consumers

docs/src/assets/favicon.ico

@@ -11,7 +11,15 @@ import globals from 'globals'
 import tseslint from 'typescript-eslint'
 
 const config = tseslint.config(
-  { ignores: ['**/dist/**', '**/node_modules/**', '**/coverage/**'] },
+  {
+    ignores: [
+      '**/dist/**',
+      '**/node_modules/**',
+      '**/coverage/**',
+      '**/examples/**',
+      '**/docs/dist/**',
+    ],
+  },
   {
     files: ['**/*.ts', '**/*.tsx'],
     extends: [