Merge pull request #139 from xmtp/rygine/typedocs

Add typedocs

.github/workflows/docs.yml

@@ -0,0 +1,27 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.14.0
+      - name: Install dependencies
+        run: npm ci
+      - name: Build typedocs
+        run: npm run typedoc
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

.gitignore

@@ -60,3 +60,6 @@ android/keystores/debug.keystore
 
 # Expo
 .expo/*
+
+# Typedocs
+docs/

package.json

@@ -14,7 +14,8 @@
     "pretty": "npx prettier '**/*.{js,ts,tsx}' --write",
     "expo-module": "expo-module",
     "open:ios": "open -a \"Xcode\" example/ios",
-    "open:android": "open -a \"Android Studio\" example/android"
+    "open:android": "open -a \"Android Studio\" example/android",
+    "typedoc": "typedoc"
   },
   "keywords": [
     "react-native",
@@ -50,7 +51,8 @@
     "@types/react-native": "^0.70.6",
     "expo-module-scripts": "^3.0.4",
     "expo-modules-core": "^1.5.9",
-    "prettier": "^3.0.0"
+    "prettier": "^3.0.0",
+    "typedoc": "^0.25.2"
   },
   "peerDependencies": {
     "expo": "*",

typedoc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "excludeExternals": true,
+  "excludePrivate": true,
+  "excludeProtected": true
+}