Sync docs config with other guides

npaisnel · Sep 15, 2024 · f394bee · f394bee
1 parent a410011
commit f394bee
Show file tree

Hide file tree

Showing 9 changed files with 10,810 additions and 34,637 deletions.
diff --git a/.github/workflows/build-site.yml b/.github/workflows/build-site.yml
@@ -11,26 +11,34 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'dortania'
     steps:
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '12'
-      - name: Checkout Repository
+      - name: Checkout
         uses: actions/checkout@v4
         with:
-          fetch-depth: '0'
-          persist-credentials: false
-          submodules: 'recursive'
-      - name: Install
-        run: npm install -d
-        working-directory: 'docs'
+          submodules: "recursive"
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: "yarn"
+          cache-dependency-path: ./yarn.lock
+      - name: Install Dependencies
+        run: yarn install --frozen-lockfile
+        working-directory: docs
       - name: Build
-        run: npm run build
-        working-directory: 'docs'
-      - name: Deploy
-        uses: JamesIves/[email protected]
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main'}}
+        run: yarn run build
+        working-directory: docs
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
-          BRANCH: gh-pages
-          FOLDER: docs/.vuepress/dist/
-          CLEAN: true
+          path: docs/.vuepress/dist/
+  deploy:
+    if: ${{ github.repository_owner == 'dortania' && github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.gitignore b/.gitignore
@@ -17,7 +17,6 @@ __pycache__/
 *$py.class
 /docs/.vuepress/dist
 /docs/.vuepress/.config.js.swp
-/docs/yarn.lock
 /docs/yarn-error.log
 /docs/node_modules/
 /payloads/List.txt

diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json
@@ -10,5 +10,6 @@
 	"single-title": false,
 	"ul-style": {
 		"style": "asterisk"
-	}
+	},
+	"link-fragments": false
 }
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -24,29 +24,29 @@ module.exports = {
     ],
     base: '/OpenCore-Legacy-Patcher/',
 
-	watch: {
-	    $page(newPage, oldPage) {
-	      if (newPage.key !== oldPage.key) {
-	        requestAnimationFrame(() => {
-	          if (this.$route.hash) {
-	            const element = document.getElementById(this.$route.hash.slice(1));
+    watch: {
+        $page(newPage, oldPage) {
+            if (newPage.key !== oldPage.key) {
+                requestAnimationFrame(() => {
+                    if (this.$route.hash) {
+                        const element = document.getElementById(this.$route.hash.slice(1));
 
-	            if (element && element.scrollIntoView) {
-	              element.scrollIntoView();
-	            }
-	          }
-	        });
-	      }
-	    }
-	  },
+                        if (element && element.scrollIntoView) {
+                            element.scrollIntoView();
+                        }
+                    }
+                });
+            }
+        }
+    },
 
-	markdown: {
-		extendMarkdown: md => {
-			md.use(require('markdown-it-multimd-table'), {
-				rowspan: true,
-			});
-		}
-	},
+    markdown: {
+        extendMarkdown: md => {
+            md.use(require('markdown-it-multimd-table'), {
+                rowspan: true,
+            });
+        }
+    },
 
     theme: 'vuepress-theme-succinct',
     globalUIComponents: [
@@ -56,19 +56,19 @@ module.exports = {
     themeConfig: {
         lastUpdated: true,
         repo: 'https://github.com/dortania/OpenCore-Legacy-Patcher/',
-		docsDir: 'docs',
-		docsBranch: 'main',
-		editLinks: true,
-		editLinkText: 'Help us improve this page!',
+        docsDir: 'docs',
+        docsBranch: 'main',
+        editLinks: true,
+        editLinkText: 'Help us improve this page!',
         logo: 'homepage.png',
 
         sidebar: [{
             title: 'Introduction',
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'START',
-				'MODELS',
+                'START',
+                'MODELS',
             ]
 
         },
@@ -78,7 +78,7 @@ module.exports = {
             sidebarDepth: 1,
             children: [
                 'INSTALLER',
-				'BUILD',
+                'BUILD',
             ]
 
         },
@@ -87,68 +87,68 @@ module.exports = {
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'BOOT',
-				'POST-INSTALL',
+                'BOOT',
+                'POST-INSTALL',
             ]
 
         },
-		        {
+        {
             title: 'macOS Sequoia',
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				['SEQUOIA-DROP', 'macOS Sequoia Support'],
+                ['SEQUOIA-DROP', 'macOS Sequoia Support'],
             ]
         },
         {
             title: 'macOS Sonoma',
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				['SONOMA-DROP', 'macOS Sonoma Support'],
+                ['SONOMA-DROP', 'macOS Sonoma Support'],
             ]
         },
-		  
-	{
+
+        {
             title: 'macOS Ventura',
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				['VENTURA-DROP', 'macOS Ventura Support'],
+                ['VENTURA-DROP', 'macOS Ventura Support'],
             ]
-        },      
-		  
-	{
+        },
+
+        {
             title: 'macOS Monterey',
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				['MONTEREY-DROP', 'macOS Monterey Support'],
+                ['MONTEREY-DROP', 'macOS Monterey Support'],
             ]
         },
         {
             title: 'Misc',
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'ACCEL',
-				'TROUBLESHOOTING',
-				'DEBUG',
-				'UPDATE',
-				'UNINSTALL',
-				'ICNS',
-				'WINDOWS',
-				'UNIVERSALCONTROL',
-		    		'PROCESS',
+                'ACCEL',
+                'TROUBLESHOOTING',
+                'DEBUG',
+                'UPDATE',
+                'UNINSTALL',
+                'ICNS',
+                'WINDOWS',
+                'UNIVERSALCONTROL',
+                'PROCESS',
             ]
         },
         {
             title: 'Credit',
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'DONATE',
-				'LICENSE',
+                'DONATE',
+                'LICENSE',
             ]
 
         },
@@ -157,23 +157,22 @@ module.exports = {
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'ISSUES-HOLD',
-				'TERMS',
-				'HOW',
-				'PATCHEXPLAIN',
+                'ISSUES-HOLD',
+                'TERMS',
+                'HOW',
+                'PATCHEXPLAIN',
             ]
 
         },
         ],
     },
     plugins: [
-        '@vuepress/plugin-back-to-top',
+        '@vuepress/back-to-top',
         'vuepress-plugin-smooth-scroll',
-	'vuepress-plugin-fulltext-search',
-	['flexsearch'],
-        ['vuepress-plugin-medium-zoom',
+        'vuepress-plugin-fulltext-search',
+        ['@vuepress/medium-zoom',
             {
-                selector: "img",
+                selector: ".theme-succinct-content :not(a) > img",
                 options: {
                     background: 'var(--bodyBgColor)'
                 }

diff --git a/docs/.vuepress/styles/index.styl b/docs/.vuepress/styles/index.styl
@@ -47,3 +47,22 @@ tr
   background-color var(--sideBgColor)!important
   box-shadow 0px 0px 2px var(--bodyBgColor)
   right -12%!important
+
+
+@media (min-width: 1000px)
+  .theme-succinct-content:not(.custom)
+    max-width 70%
+
+.search-box .suggestion a .suggestion-row .page-title
+  border-color var(--borderColor) !important
+  background-color: var(--sideBgColor) !important
+
+.search-box .suggestion a .suggestion-row .suggestion-content
+  border-color var(--borderColor) !important
+
+.search-box .suggestion a .parent-page-title
+  background-color: var(--bodyBgColor) !important
+  color: var(--accentColor) !important
+
+.search-box .suggestion.focused a
+  color: var(--navItemHoverColor) !important
diff --git a/docs/.vuepress/styles/palette.styl b/docs/.vuepress/styles/palette.styl
@@ -22,4 +22,4 @@ $bodyBgColorDark = #2d3033
 $sideBgColorDark = #363b40
 $badgeTipColorDark = #023e52
 
-$contentWidth = 900px
+$contentWidth = 900px