Skip to content

Commit

Permalink
Merge pull request #971 from Agoric/pc/vitepress
Browse files Browse the repository at this point in the history
feat(vitepress): updates site to use vitepress
  • Loading branch information
0xpatrickdev authored Mar 14, 2024
2 parents 8e7f38d + b1eed18 commit 1c9e995
Show file tree
Hide file tree
Showing 103 changed files with 2,896 additions and 8,472 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-deploy-doc.yml.DISABLED
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ jobs:
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Provided by github: https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#about-the-github_token-secret
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: main/.vuepress/dist # The folder the action should deploy
FOLDER: main/.vitepress/dist # The folder the action should deploy
CLEAN: true # Automatically remove deleted files from the deploy branch
8 changes: 2 additions & 6 deletions .github/workflows/test-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,13 @@ jobs:
with:
node-version: ${{ matrix.node-version }}

- name: Install and Build
- name: Install, Build, Check Links
run: |
yarn install
yarn docs:build
- name: HTML5 Validator
uses: Cyb3r-Jak3/html5validator-action@master
with:
root: main/.vuepress/dist
root: main/.vitepress/dist
extra: --ignore_re r'\ADuplicate ID "outbound-link-title".*'

- name: Vuepress checkmd
run: |
yarn check-links
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ dist/
.DS_Store
_agstate
mlc-config.json
main/.vitepress/cache/
2 changes: 1 addition & 1 deletion .pyspelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ matrix:
ignores:
- div
sources:
- 'main/.vuepress/dist/**/*.html'
- 'main/.vitepress/dist/**/*.html'
default_encoding: utf-8
101 changes: 55 additions & 46 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

80 changes: 58 additions & 22 deletions _redirects
Original file line number Diff line number Diff line change
@@ -1,34 +1,70 @@
# Send to a 404 error page on the main site for things we don't recognize.
/wallet-api/ /guides/wallet/
/wallet-api.html /guides/wallet/
/chainlink-integration/ /guides/chainlink-integration/
/chainlink-integration /guides/chainlink-integration/
/chainlink-integration.html /guides/chainlink-integration/
/distributed-programming/ /guides/js-programming/
/chainlink-integration/ /guides/chainlink-integration/
/chainlink-integration/* /guides/chainlink-integration/:splat
/dapps /guides/dapps/
/dapps/ /guides/dapps/
/dapps/* /guides/dapps/:splat
/distributed-programming /guides/js-programming/
/distributed-programming.html /guides/js-programming/
/getting-started/agoric-cli-guide/ /guides/agoric-cli/
/distributed-programming/ /guides/js-programming/
/distributed-programming/* /guides/js-programming/:splat
/ertp/api /reference/ertp-api/
/ertp/api/ /reference/ertp-api/
/ertp/api/* /reference/ertp-api/:splat
/ertp/api/issuer.html /reference/ertp-api/issuer.html
/ertp/guide /guides/ertp/
/ertp/guide/ /guides/ertp/
/ertp/guide/* /guides/ertp/:splat
/ertp/guide/amounts.html /guides/ertp/amounts.html
/getting-started/ /guides/getting-started/
/getting-started/agoric-cli-guide /guides/agoric-cli/
/getting-started/agoric-cli-guide.html /guides/agoric-cli/
/guides/js-programming/ses/ses-guide.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/guide.html
/guides/js-programming/ses/ses-reference.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/reference.html
/guides/js-programming/ses/lockdown.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/lockdown.html
/getting-started/agoric-cli-guide/ /guides/agoric-cli/
/getting-started/agoric-cli-guide/* /guides/agoric-cli/:splat
/getting-started/before-using-agoric /guides/getting-started/
/getting-started/before-using-agoric.html /guides/getting-started/
/getting-started/before-using-agoric/* /guides/getting-started/:splat
/getting-started/beta /guides/getting-started/
/getting-started/beta.html /guides/getting-started/
/getting-started/beta/* /guides/getting-started/:splat
/getting-started/intro-zoe /guides/zoe/offer-enforcement/
/getting-started/intro-zoe.html /guides/zoe/offer-enforcement.html
/getting-started/intro-zoe/* /guides/zoe/offer-enforcement/:splat
/getting-started/start-a-project /guides/getting-started/start-a-project/
/getting-started/start-a-project.html /guides/getting-started/
/getting-started/start-a-project/* /guides/getting-started/start-a-project/:splat
/guides/agoric-cli/commands /guides/agoric-cli/
/guides/agoric-cli/commands.html /guides/agoric-cli/
/dapps/ /guides/dapps/
/ertp/guide/ /guides/ertp/
/ertp/guide/amounts.html /guides/ertp/amounts.html
/guides/agoric-cli/commands/* /guides/agoric-cli/:splat
/guides/js-programming/ses/lockdown https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/lockdown.md
/guides/js-programming/ses/lockdown.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/lockdown.md
/guides/js-programming/ses/ses-guide https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/guide.md
/guides/js-programming/ses/ses-guide.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/guide.md
/guides/js-programming/ses/ses-reference https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/reference.md
/guides/js-programming/ses/ses-reference.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/reference.md
/guides/wallet/api /reference/wallet-api/
/guides/wallet/api.html /reference/wallet-api.html
/guides/wallet/api/* /reference/wallet-api/:splat
/platform /guides/platform/
/platform/* /guides/platform/:splat
/zoe/guide/ /guides/zoe/
/getting-started/intro-zoe.html /guides/zoe/offer-enforcement.html
/zoe/guide/offer-safety.html /guides/zoe/offer-safety 302
/zoe/guide/contracts/ /guides/zoe/contracts/
/zoe/guide/contracts/oracle.html /guides/zoe/contracts/oracle.html
/ertp/api/ /reference/ertp-api/
/ertp/api/issuer.html /reference/ertp-api/issuer.html
/platform /guides/platform/
/platform/* /guides/platform/:splat
/repl /reference/repl/
/repl/ /reference/repl/
/repl/* /reference/repl/:splat
/repl/timerServices.html /reference/repl/timerServices.html
/guides/wallet/api.html /reference/wallet-api.html
/wallet-api /guides/wallet/
/wallet-api.html /guides/wallet/
/wallet-api/ /guides/wallet/
/wallet-api/* /guides/wallet/:splat
/zoe/api /reference/zoe-api/
/zoe/api/ /reference/zoe-api/
/zoe/api/* /reference/zoe-api/:splat
/zoe/api/zoe.html /reference/zoe-api/zoe.html
/getting-started/beta.html /guides/getting-started/
/getting-started/ /guides/getting-started/
/zoe/guide /guides/zoe/
/zoe/guide/ /guides/zoe/
/zoe/guide/* /guides/zoe/:splat
/zoe/guide/contracts/ /guides/zoe/contracts/
/zoe/guide/contracts/oracle.html /guides/zoe/contracts/oracle.html
/zoe/guide/offer-safety.html /guides/zoe/offer-safety 302
File renamed without changes.
12 changes: 12 additions & 0 deletions main/.vitepress/components/Zoe-Version.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<script setup>
import { useData } from 'vitepress'
const { theme } = useData()
const { zoeVersion, zoeDocsUpdated } = theme.value
</script>

<template>
<div class="zoe-version">
Zoe {{ zoeVersion }}. Last updated
{{ zoeDocsUpdated }}.
</div>
</template>
Loading

0 comments on commit 1c9e995

Please sign in to comment.