misc tweaks

- add google analytics
- auto build algolia index
- update edit URL
- etc.

Author: terrafrost

.github/workflows/ci.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - source
+  # Lets you re-index on demand from the Actions tab without pushing.
+  workflow_dispatch:
 
 permissions:
   contents: read
@@ -43,4 +45,27 @@ jobs:
 
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@v4
+
+  index-search:
+    needs: build-and-deploy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # deploy-pages returns as soon as the deployment is created; the CDN
+      # needs a moment before the crawler sees the new pages.
+      - name: Let the deployment propagate
+        run: sleep 60
+
+      - name: Run DocSearch scraper
+        env:
+          APPLICATION_ID: 9JAHOV00P8
+          API_KEY: ${{ secrets.ALGOLIA_ADMIN_KEY }}
+        run: |
+          docker run \
+            -e APPLICATION_ID \
+            -e API_KEY \
+            -e "CONFIG=$(jq -r tostring < docsearch-config.json)" \
+            algolia/docsearch-scraper

docusaurus.config.js

@@ -64,7 +64,7 @@ const config = {
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+            'https://github.com/phpseclib/phpseclib.github.io/tree/source/',
         },
         blog: {
           showReadingTime: true,
@@ -75,7 +75,7 @@ const config = {
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+            'https://github.com/phpseclib/phpseclib.github.io/tree/source/',
           // Useful options to enforce blogging best practices
           onInlineTags: 'warn',
           onInlineAuthors: 'warn',
@@ -84,6 +84,10 @@ const config = {
         theme: {
           customCss: './src/css/custom.css',
         },
+        gtag: {
+          trackingID: 'G-7M7XG2FC7M',
+          anonymizeIP: true,
+        },
       }),
     ],
   ],
@@ -106,9 +110,9 @@ const config = {
 
       algolia: {
         appId: '9JAHOV00P8',
-        apiKey: 'fc750310b29e51d39b7b66d0eca261b7',
+        apiKey: 'd88000c9cf09fd7067f2db65c22d7c87',
         indexName: 'phpseclib',
-        contextualSearch: false,
+        contextualSearch: true,
         searchParameters: {},
       },
 

temp.sh

@@ -0,0 +1,7 @@
+for d in docs versioned_docs/version-4.0 versioned_docs/version-3.0; do
+  for s in cms file; do
+    [ -d "$d/$s/inc" ] && git mv "$d/$s/inc" "$d/$s/_inc"
+  done
+done
+
+grep -rl "from './inc/" docs versioned_docs | xargs sed -i "s|from '\./inc/|from './_inc/|g"