From 888face64e94c8a0837c12d5325f22143fb04974 Mon Sep 17 00:00:00 2001 From: ndeet Date: Tue, 19 Dec 2023 13:39:48 +0100 Subject: [PATCH] Add Smartstore docs. --- .gitignore | 1 + README.md | 2 +- docs/.vuepress/config.js | 1 + docs/.vuepress/preprocessMarkdown.js | 3 ++- setup-deps.sh | 19 +++++++++++++++++++ 5 files changed, 24 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 0a845c48d7..cdb1f0756d 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ /docs/LNDhubAPI /docs/Nostr /docs/PodServer +/docs/Smartstore /docs/TicketTailor /docs/Trocador /docs/Wabisabi diff --git a/README.md b/README.md index cae0b593e1..79a5ee7cb1 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ This document explains how to **integrate BTCPay Server into your WooCommerce st ### Embedding YouTube videos -To add a YouTube video with a preview, you can so so by linking to it like this: +To add a YouTube video with a preview, you can do so by linking to it like this: ```md [![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/mqdefault.jpg)](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index f2a7a453cc..587351fbb2 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -112,6 +112,7 @@ const sidebarUserGuide = [ ['/Zapier/', 'Zapier'], ['/Shopware', 'Shopware'], ['/VirtueMart', 'VirtueMart'], + ['/Smartstore/', 'Smartstore'], ['/CustomIntegration', 'Custom Integration'] ] }, diff --git a/docs/.vuepress/preprocessMarkdown.js b/docs/.vuepress/preprocessMarkdown.js index 5d38c305f2..6de07d6a46 100644 --- a/docs/.vuepress/preprocessMarkdown.js +++ b/docs/.vuepress/preprocessMarkdown.js @@ -15,7 +15,8 @@ const EXTERNAL_DOCS = { 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' + Wabisabi: 'https://github.com/Kukks/BTCPayServerPlugins/tree/master/Plugins/BTCPayServer.Plugins.Wabisabi', + Smartstore: 'https://github.com/btcpayserver/Smartstore.BTCPayServer.git' } const replaceExternalRepoLinks = (source, externalRepoUrl, resourcePath) => { diff --git a/setup-deps.sh b/setup-deps.sh index 28e8fd8a1a..5e6a1b0140 100755 --- a/setup-deps.sh +++ b/setup-deps.sh @@ -17,6 +17,7 @@ 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" +SMARTSTORE_DIR="$BASE_DIR/deps/smartstore" update_external() { file="$1" @@ -263,6 +264,24 @@ for file in "$DOCS_DIR"/Trocador/*.md; do update_external "$file" https://github.com/saltrafael/trocador-plugin "$DOCS_DIR"/Trocador/ done +# Smartstore + +echo "Setup dependency: Smartstore" + +rm -rf "$SMARTSTORE_DIR" +rm -rf "$DOCS_DIR/Smartstore" +mkdir -p "$DOCS_DIR/Smartstore" + +if [ ! -d "$SMARTSTORE_DIR" ]; then + git clone --depth 1 https://github.com/btcpayserver/Smartstore.BTCPayServer.git "$SMARTSTORE_DIR" +fi + +cd "$SMARTSTORE_DIR" +cp -r src/Smartstore.Modules/Smartstore.BTCPayServer/README.md "$DOCS_DIR/Smartstore" +for file in "$DOCS_DIR"/Smartstore/*.md; do + update_external "$file" https://github.com/btcpayserver/Smartstore.BTCPayServer.git "$DOCS_DIR"/Smartstore/ +done + # Kukks' plugins echo "Setup dependency: Kukks' plugins"