Add LNDhub API plugin docs (#1439)

Re-adding the docs for this plugin, which I'll make available with v2 again.
btcpayserver · Oct 30, 2024 · 86a9be8 · 86a9be8
1 parent 1984beb
commit 86a9be8
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,7 @@
 /docs/Drupal
 /docs/DynamicReports
 /docs/Grandnode
+/docs/LNDhubAPI
 /docs/NBXplorer
 /docs/Nopcommerce
 /docs/Nostr

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -133,6 +133,7 @@ const sidebarUserGuide = [
     collapsable: false,
     initialOpenGroupIndex: -1,
     children: [
+      ['/LNDhubAPI/', 'LNDhub API'],
       ['/Nostr/', 'Nostr'],
       ['/TicketTailor/', 'TicketTailor'],
       ['/Trocador/', 'Trocador'],
@@ -145,7 +146,7 @@ const sidebarUserGuide = [
       [
         `https://dev.blink.sv/examples/btcpayserver-plugin`,
         'Blink',
-        { type: 'external' } 
+        { type: 'external' }
       ],
     ]
   },

diff --git a/docs/.vuepress/preprocessMarkdown.js b/docs/.vuepress/preprocessMarkdown.js
@@ -9,6 +9,7 @@ const EXTERNAL_DOCS = {
   Vault: 'https://github.com/btcpayserver/BTCPayServer.Vault',
   Transmuter: 'https://github.com/btcpayserver/btcTransmuter',
   Zapier: 'https://github.com/btcpayserver/zapier',
+  LNDhubAPI: 'https://github.com/dennisreimann/btcpayserver-plugin-lndhub-api',
   Nostr: 'https://github.com/Kukks/BTCPayServerPlugins/tree/master/Plugins/BTCPayServer.Plugins.NIP05',
   TicketTailor: 'https://github.com/Kukks/BTCPayServerPlugins/tree/master/Plugins/BTCPayServer.Plugins.TicketTailor',
   Trocador: 'https://github.com/saltrafael/trocador-plugin',

diff --git a/docs/Development/Plugins.md b/docs/Development/Plugins.md
@@ -349,4 +349,6 @@ Once you click the `Release` button on the build page, the package won't be in p
 For more information check out these repositories with existing plugins:
 
 - [kukks' plugins](https://github.com/Kukks/BTCPayServerPlugins)
+- [rockstardev' plugins](https://github.com/rockstardev/BTCPayServerPlugins.RockstarDev)
+- [LNDhub API](https://github.com/dennisreimann/btcpayserver-plugin-lndhub-api)
 - [Trocador.app](https://github.com/saltrafael/trocador-plugin)
diff --git a/setup-deps.sh b/setup-deps.sh
@@ -13,6 +13,7 @@ VAULT_DIR="$BASE_DIR/deps/vault"
 TRANSMUTER_DIR="$BASE_DIR/deps/transmuter"
 ZAPIER_DIR="$BASE_DIR/deps/zapier"
 TROCADOR_DIR="$BASE_DIR/deps/trocador"
+LNDHUBAPI_DIR="$BASE_DIR/deps/lndhub-api"
 KUKKS_DIR="$BASE_DIR/deps/kukks"
 TOBSES_DIR="$BASE_DIR/deps/tobses"
 SMARTSTORE_DIR="$BASE_DIR/deps/smartstore"
@@ -192,6 +193,25 @@ for file in "$DOCS_DIR"/Zapier/*.md; do
   update_external "$file" https://github.com/btcpayserver/zapier "$DOCS_DIR"/Zapier/
 done
 
+# LNDhub API
+
+echo "Setup dependency: LNDhub API"
+
+rm -rf "$LNDHUBAPI_DIR"
+rm -rf "$DOCS_DIR/LNDhubAPI"
+mkdir -p "$DOCS_DIR/LNDhubAPI"
+
+if [ ! -d "$LNDHUBAPI_DIR" ]; then
+  git clone --depth 1 https://github.com/dennisreimann/btcpayserver-plugin-lndhub-api.git "$LNDHUBAPI_DIR"
+fi
+
+cd "$LNDHUBAPI_DIR"
+cp -r README.md docs/* "$DOCS_DIR/LNDhubAPI"
+sed -ie 's$(./docs/$(./$g' "$DOCS_DIR/LNDhubAPI/README.md"
+for file in "$DOCS_DIR"/LNDhubAPI/*.md; do
+  update_external "$file" https://github.com/dennisreimann/btcpayserver-plugin-lndhub-api "$DOCS_DIR"/LNDhubAPI/
+done
+
 # Trocador
 
 echo "Setup dependency: Trocador"
@@ -286,7 +306,7 @@ cp -r README.md "$DOCS_DIR/Nopcommerce"
 for file in "$DOCS_DIR"/Nopcommerce/*.md; do
   update_external "$file" https://github.com/btcpayserver/nopcommercee.git "$DOCS_DIR"/Nopcommerce/
 done
- 
+
 # Wix
 echo "Setup dependency: Wix"