Sync docs config with other guides

This commit is contained in:
Dhinak G
2024-09-15 14:25:01 -04:00
parent a41001130f
commit f394bee0f5
9 changed files with 10811 additions and 34638 deletions

View File

@@ -11,26 +11,34 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: github.repository_owner == 'dortania' if: github.repository_owner == 'dortania'
steps: steps:
- uses: actions/setup-node@v4 - name: Checkout
with:
node-version: '12'
- name: Checkout Repository
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
fetch-depth: '0' submodules: "recursive"
persist-credentials: false - name: Setup Node
submodules: 'recursive' uses: actions/setup-node@v4
- name: Install
run: npm install -d
working-directory: 'docs'
- name: Build
run: npm run build
working-directory: 'docs'
- name: Deploy
uses: JamesIves/github-pages-deploy-action@3.7.1
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main'}}
with: with:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} node-version: "22"
BRANCH: gh-pages cache: "yarn"
FOLDER: docs/.vuepress/dist/ cache-dependency-path: ./yarn.lock
CLEAN: true - name: Install Dependencies
run: yarn install --frozen-lockfile
working-directory: docs
- name: Build
run: yarn run build
working-directory: docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
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

1
.gitignore vendored
View File

@@ -17,7 +17,6 @@ __pycache__/
*$py.class *$py.class
/docs/.vuepress/dist /docs/.vuepress/dist
/docs/.vuepress/.config.js.swp /docs/.vuepress/.config.js.swp
/docs/yarn.lock
/docs/yarn-error.log /docs/yarn-error.log
/docs/node_modules/ /docs/node_modules/
/payloads/List.txt /payloads/List.txt

View File

@@ -10,5 +10,6 @@
"single-title": false, "single-title": false,
"ul-style": { "ul-style": {
"style": "asterisk" "style": "asterisk"
} },
"link-fragments": false
} }

View File

@@ -167,13 +167,12 @@ module.exports = {
], ],
}, },
plugins: [ plugins: [
'@vuepress/plugin-back-to-top', '@vuepress/back-to-top',
'vuepress-plugin-smooth-scroll', 'vuepress-plugin-smooth-scroll',
'vuepress-plugin-fulltext-search', 'vuepress-plugin-fulltext-search',
['flexsearch'], ['@vuepress/medium-zoom',
['vuepress-plugin-medium-zoom',
{ {
selector: "img", selector: ".theme-succinct-content :not(a) > img",
options: { options: {
background: 'var(--bodyBgColor)' background: 'var(--bodyBgColor)'
} }

View File

@@ -47,3 +47,22 @@ tr
background-color var(--sideBgColor)!important background-color var(--sideBgColor)!important
box-shadow 0px 0px 2px var(--bodyBgColor) box-shadow 0px 0px 2px var(--bodyBgColor)
right -12%!important 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

34543
docs/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -33,19 +33,17 @@
}, },
"license": "CC-BY-NC-SA-4.0", "license": "CC-BY-NC-SA-4.0",
"devDependencies": { "devDependencies": {
"@vuepress/plugin-back-to-top": "^1.9.10", "@vuepress/plugin-back-to-top": "^1.9.8",
"markdown-it-multimd-table": "^4.2.3", "@vuepress/plugin-medium-zoom": "^1.9.8",
"markdown-link-check": "^3.11.2", "markdown-it-multimd-table": "^4.2.0",
"markdownlint-cli": "^0.37.0", "markdown-link-check": "^3.10.3",
"markdownlint-cli": "^0.33.0",
"run-script-os": "^1.1.6", "run-script-os": "^1.1.6",
"spellchecker-cli": "^6.1.1", "spellchecker-cli": "^6.1.1",
"vuepress": "^1.9.10", "vuepress": "^1.9.8",
"vuepress-plugin-medium-zoom": "^1.1.9", "vuepress-plugin-fulltext-search": "^2.2.1",
"vuepress-plugin-zooming": "^1.1.8", "vuepress-theme-succinct": "^1.7.2"
"vuepress-theme-book": "0.0.9",
"vuepress-theme-dark-new": "^0.1.2",
"vuepress-theme-succinct": "^1.7.2",
"vuepress-theme-yuu": "^3.1.1"
}, },
"homepage": "https://dortania.github.io/OpenCore-Legacy-Patcher/" "homepage": "https://dortania.github.io/OpenCore-Legacy-Patcher/",
"packageManager": "yarn@1.22.19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447"
} }

10692
docs/yarn.lock Normal file

File diff suppressed because it is too large Load Diff