Add PodServer docs and order plugins in nav alphabetically (#1441)

* Add PodServer docs * Order plugins alphabetically
btcpayserver · Nov 6, 2024 · be134c6 · be134c6
1 parent 86a9be8
commit be134c6
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,7 @@
 /docs/Nopcommerce
 /docs/Nostr
 /docs/Payroll
+/docs/PodServer
 /docs/SideShift
 /docs/Smartstore
 /docs/TicketTailor

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -133,21 +133,22 @@ const sidebarUserGuide = [
     collapsable: false,
     initialOpenGroupIndex: -1,
     children: [
-      ['/LNDhubAPI/', 'LNDhub API'],
-      ['/Nostr/', 'Nostr'],
-      ['/TicketTailor/', 'TicketTailor'],
-      ['/Trocador/', 'Trocador'],
-      ['/SideShift/', 'SideShift'],
-      ['/Bringin/', 'Bringin'],
-      ['/Payroll/', 'Payroll'],
-      ['/DynamicReports/', 'Dynamic Reports'],
-      ['/Breez/', 'Breez'],
-      ['/Wabisabi/', 'Wabisabi Coinjoin'],
       [
         `https://dev.blink.sv/examples/btcpayserver-plugin`,
         'Blink',
         { type: 'external' }
       ],
+      ['/Breez/', 'Breez'],
+      ['/Bringin/', 'Bringin'],
+      ['/DynamicReports/', 'Dynamic Reports'],
+      ['/LNDhubAPI/', 'LNDhub API'],
+      ['/Nostr/', 'Nostr'],
+      ['/Payroll/', 'Payroll'],
+      ['/PodServer/', 'PodServer'],
+      ['/SideShift/', 'SideShift'],
+      ['/TicketTailor/', 'TicketTailor'],
+      ['/Trocador/', 'Trocador'],
+      ['/Wabisabi/', 'Wabisabi Coinjoin'],
     ]
   },
   {

diff --git a/docs/.vuepress/preprocessMarkdown.js b/docs/.vuepress/preprocessMarkdown.js
@@ -11,6 +11,7 @@ const EXTERNAL_DOCS = {
   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',
+  PodServer: 'https://github.com/dennisreimann/btcpayserver-plugin-podserver',
   TicketTailor: 'https://github.com/Kukks/BTCPayServerPlugins/tree/master/Plugins/BTCPayServer.Plugins.TicketTailor',
   Trocador: 'https://github.com/saltrafael/trocador-plugin',
   Wabisabi: 'https://github.com/Kukks/BTCPayServerPlugins/tree/master/Plugins/BTCPayServer.Plugins.Wabisabi',

diff --git a/docs/Development/Plugins.md b/docs/Development/Plugins.md
@@ -351,4 +351,5 @@ 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)
+- [PodServer](https://github.com/dennisreimann/btcpayserver-plugin-podserver)
 - [Trocador.app](https://github.com/saltrafael/trocador-plugin)
diff --git a/setup-deps.sh b/setup-deps.sh
@@ -12,6 +12,7 @@ DOCKER_DIR="$BASE_DIR/deps/docker"
 VAULT_DIR="$BASE_DIR/deps/vault"
 TRANSMUTER_DIR="$BASE_DIR/deps/transmuter"
 ZAPIER_DIR="$BASE_DIR/deps/zapier"
+PODSERVER_DIR="$BASE_DIR/deps/podserver"
 TROCADOR_DIR="$BASE_DIR/deps/trocador"
 LNDHUBAPI_DIR="$BASE_DIR/deps/lndhub-api"
 KUKKS_DIR="$BASE_DIR/deps/kukks"
@@ -193,6 +194,25 @@ for file in "$DOCS_DIR"/Zapier/*.md; do
   update_external "$file" https://github.com/btcpayserver/zapier "$DOCS_DIR"/Zapier/
 done
 
+# PodServer
+
+echo "Setup dependency: PodServer"
+
+rm -rf "$PODSERVER_DIR"
+rm -rf "$DOCS_DIR/PodServer"
+mkdir -p "$DOCS_DIR/PodServer"
+
+if [ ! -d "$PODSERVER_DIR" ]; then
+  git clone --depth 1 https://github.com/dennisreimann/btcpayserver-plugin-podserver.git "$PODSERVER_DIR"
+fi
+
+cd "$PODSERVER_DIR"
+cp -r README.md docs/* "$DOCS_DIR/PodServer"
+sed -ie 's$(./docs/$(./$g' "$DOCS_DIR/PodServer/README.md"
+for file in "$DOCS_DIR"/PodServer/*.md; do
+  update_external "$file" https://github.com/dennisreimann/btcpayserver-plugin-podserver "$DOCS_DIR"/PodServer/
+done
+
 # LNDhub API
 
 echo "Setup dependency: LNDhub API"