VuePress proof of concept basics

.github/workflows/nodejs.yml

@@ -0,0 +1,42 @@
+name: Node CI
+
+on:
+  push:
+    branches:
+      - master
+      - vuepress
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+    - name: Setup (Node.js ${{ matrix.node-version }})
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install
+      run: npm ci
+    - name: Build
+      run: |
+        npm run build
+        # https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/
+        touch docs/.vuepress/dist/.nojekyll
+        # https://help.github.com/en/articles/managing-a-custom-domain-for-your-github-pages-site
+        # echo docs.btcpayserver.org > docs/.vuepress/dist/CNAME
+        echo btcpaydocs.uix.space > docs/.vuepress/dist/CNAME
+      env:
+        CI: true
+        TRANSIFEX_TOKEN: ${{ secrets.TRANSIFEX_TOKEN }}
+    - name: Deploy
+      if: success()
+      uses: maxheld83/[email protected]
+      env:
+        BUILD_DIR: docs/.vuepress/dist/
+        GH_PAT: ${{ secrets.GH_PAT }}

.gitignore

@@ -0,0 +1,2 @@
+/docs/.vuepress/dist
+/node_modules

docs/.vuepress/config.js

@@ -0,0 +1,227 @@
+module.exports = {
+  title: "BTCPay Server Docs",
+  description: "BTCPay Server Official Documentation",
+  head: [
+    ["link", { rel: "apple-touch-icon", href: "/apple-touch-icon.png", sizes: "180x180" }],
+    ["link", { rel: "icon", type: "image/png", sizes: "32x32", href: "/favicon-32x32.png" }],
+    ["link", { rel: "icon", type: "image/png", sizes: "16x16", href: "/favicon-16x16.png" }],
+    ["link", { rel: "manifest", href: "/site.webmanifest" }],
+    ["link", { rel: "mask-icon", href: "/safari-pinned-tab.svg", color: "#51b13e" }],
+    ["meta", { name: "msapplication-TileColor", content: "#0f3b21" }],
+    ["meta", { name: "theme-color", content: "#ffffff" }],
+  ],
+  themeConfig: {
+    logo: "/img/btcpay-logo.svg",
+    displayAllHeaders: false,
+    repo: "btcpayserver/btcpayserver-doc",
+    docsDir: "docs",
+    editLinks: true,
+    sidebarDepth: 1,
+    nav: [
+      {
+        text: "Website",
+        link: "https://btcpayserver.org/"
+      },
+      {
+        text: "GitHub",
+        link: "https://github.com/btcpayserver/"
+      },
+      {
+        text: "Chat",
+        link: "https://chat.btcpayserver.org/"
+      },
+      {
+        text: "Twitter",
+        link: "https://twitter.com/BtcpayServer"
+      }
+    ],
+    sidebar: [
+      {
+        title: "Introduction",
+        path: "/",
+        sidebarDepth: 1
+      },
+      {
+        title: "BTCPay Basics",
+        collapsable: false,
+        sidebarDepth: 1,
+        children: [
+          {
+            title: "Use Case",
+            path: "UseCase"
+          },
+          {
+            title: "Walkthrough",
+            path: "Walkthrough"
+          },
+          {
+            title: "BTCPay vs. other processors",
+            path: "BTCPayVsOthers"
+          },
+          "TryItOut"
+        ]
+      },
+      {
+        title: "Deployment",
+        collapsable: false,
+        sidebarDepth: 0,
+        children: [
+          "Deployment",
+          {
+            title: "Web Deployment",
+            path: "LunaNodeWebDeployment"
+          },
+          "AzureDeployment",
+          "DockerDeployment",
+          "GoogleCloudDeployment",
+          {
+            title: "Manual Deployment",
+            path: "ManualDeployment",
+            collapsable: false,
+            sidebarDepth: 0,
+            children: [
+              "ManualDeploymentExtended"
+            ]
+          },
+          "HardwareDeployment",
+          {
+            title: "Raspberry Pi Deployment",
+            path: "RaspberryPiDeployment",
+            sidebarDepth: 0,
+            children: [
+              "RPi3",
+              "RPi4"
+            ]
+          },
+          "ThirdPartyHosting",
+          {
+            title: "Advanced Deployment",
+            collapsable: false,
+            sidebarDepth: 0,
+            children: [
+              "DynamicDNS",
+              "ReverseSSHtunnel"
+            ]
+          }
+        ]
+      },
+      {
+        title: "Getting Started",
+        collapsable: false,
+        sidebarDepth: 0,
+        children: [
+          "RegisterAccount",
+          "CreateStore",
+          {
+            title: "(3) Connect a Wallet",
+            path: "ConnectWallet",
+            collapsable: false,
+            sidebarDepth: 0,
+            children: [
+              {
+                title: "Ledger Wallet",
+                path: "LedgerWallet"
+              },
+              {
+                title: "ColdCard Wallet",
+                path: "ColdCardWallet"
+              },
+              {
+                title: "Wasabi Wallet",
+                path: "WasabiWallet"
+              },
+              {
+                title: "Electrum Wallet",
+                path: "ElectrumWallet",
+                children: [
+                  "ElectrumX",
+                  "ElectrumPersonalServer"
+                ]
+              },
+              {
+                title: "Hot Wallet",
+                path: "HotWallet"
+              },
+            ]
+          },
+          "WhatsNext"
+        ]
+      },
+      {
+        title: "Features",
+        collapsable: false,
+        sidebarDepth: 0,
+        children: [
+          {
+            title: "Wallet",
+            path: "Wallet",
+            collapsable: false,
+            sidebarDepth: 0,
+            children: [
+              {
+                title: "Hot Wallet",
+                path: "HotWallet"
+              },
+            ]
+          },
+          "Invoices",
+          {
+            title: "Apps",
+            path: "Apps"
+          },
+          {
+            title: "Lightning Network",
+            path: "LightningNetwork"
+          },
+          {
+            title: "Accounting",
+            path: "Accounting"
+          },
+          "PaymentRequests",
+          {
+            title: "Hardware Wallet Integration",
+            path: "Vault"
+          },
+          {
+            title: "Payjoin",
+            path: "Payjoin",
+            sidebarDepth: 0,
+            children: [
+              {
+                title: "Payjoin Specification",
+                path: "Payjoin-spec"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        title: "Integrations",
+        collapsable: false,
+        sidebarDepth: 0,
+        children: [
+          {
+            title: "WooCommerce",
+            path: "WooCommerce"
+          },
+          {
+            title: "Drupal",
+            path: "Drupal"
+          },
+          {
+            title: "Magento",
+            path: "Magento"
+          },
+          {
+            title: "PrestaShop",
+            path: "PrestaShop"
+          },
+          {
+            title: "Custom Integration",
+            path: "CustomIntegration"
+          }
+        ]
+      }
+    ]
+  }
+}

docs/.vuepress/public/browserconfig.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+  <msapplication>
+    <tile>
+      <square150x150logo src="/mstile-150x150.png"/>
+      <TileColor>#0f3b21</TileColor>
+    </tile>
+  </msapplication>
+</browserconfig>