Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(vitepress): updates site to use vitepress #971

Merged
merged 38 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
9b64660
feat: vuepress -> vitepress
0xpatrickdev Feb 9, 2024
dbc3632
feat(styles): default vitepress theme
0xpatrickdev Feb 9, 2024
37ac6cb
feat(vitepress): snippets path resolution
0xpatrickdev Feb 9, 2024
9844392
feat(vitepress): rename README.md -> index.md
0xpatrickdev Feb 9, 2024
6e1000a
feat(vitepress): update sidebar key names
0xpatrickdev Feb 9, 2024
bedd10a
refactor(vitepress): sidebar use text and link objects instead of pat…
0xpatrickdev Feb 9, 2024
8deb74f
refactor(vitepress): set sidebar collapsed true
0xpatrickdev Feb 9, 2024
badf655
refactor(vitepress): register components
0xpatrickdev Feb 9, 2024
41fdeeb
refactor(vitepress): agoric brand theme
0xpatrickdev Feb 9, 2024
f748428
fix: index.md has extra double quote
0xpatrickdev Feb 9, 2024
c588227
feat(vitepress): add docs:preview script
0xpatrickdev Feb 9, 2024
d2cabba
refactor(vitepress): move public to srcDir (main)
0xpatrickdev Feb 9, 2024
388fe30
refactor: light/dark mode friendly logo
0xpatrickdev Feb 9, 2024
f5f9406
refactor(vitepress): support existing stylus styles
0xpatrickdev Feb 9, 2024
d808549
refactor(vitepress): route redirects (wip)
0xpatrickdev Feb 9, 2024
e06b4f8
feat(vitepress): enable minisearch
0xpatrickdev Feb 9, 2024
0be2346
refactor(vitepress): themeConfig.zoeVersion in Zoe-Version.vue undefined
0xpatrickdev Feb 9, 2024
135131d
fix(vitepress): ci jobs
0xpatrickdev Feb 9, 2024
5eb809a
chore(vitepress): update docs
0xpatrickdev Feb 9, 2024
c1ee29f
refactor(vitepress): ensure all links are active
0xpatrickdev Feb 9, 2024
6f4c403
refactor(vitepress): lastUpdatedAt configuration
0xpatrickdev Feb 10, 2024
e963c1f
feat: add sitemap
0xpatrickdev Feb 10, 2024
c283f04
refactor: remove extraneous .html extension
0xpatrickdev Feb 10, 2024
f7a6c5a
refactor: drop extraneous .md
0xpatrickdev Feb 10, 2024
d33e24f
chore: remove old markdown link check config
0xpatrickdev Feb 10, 2024
2760d58
refactor(nav): wallet-api hierachy
0xpatrickdev Feb 10, 2024
062a025
refactor(home): preserve existing styles
0xpatrickdev Feb 10, 2024
9a30651
fix(redirects): github links 404
0xpatrickdev Feb 13, 2024
6320811
docs: update CONTRIBUTING.md
0xpatrickdev Feb 20, 2024
6ad99d9
Merge branch 'main' into pc/vitepress
0xpatrickdev Feb 20, 2024
5594baa
chore(ci): set outDir to /dist in project root
0xpatrickdev Feb 20, 2024
37b292d
docs: internal links should not include .md file extensions
0xpatrickdev Feb 29, 2024
4a6158c
Merge branch 'main' into pc/vitepress
0xpatrickdev Mar 14, 2024
5983738
fix: remove custom scroll restoration logic
0xpatrickdev Mar 14, 2024
5358d21
fix: mobile styles
0xpatrickdev Mar 14, 2024
c69ed8a
fix(vitepress): restore existing redirects logic
0xpatrickdev Mar 14, 2024
df40be4
fixup! fix(vitepress): restore existing redirects logic
0xpatrickdev Mar 14, 2024
b1eed18
refactor(redirects): alphabetize and remove duplicates
0xpatrickdev Mar 14, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 }}.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the future, do we we get value out of this? It's hardcoded to August 25, 2022. VuePress had a lastUpdatedAt plugin for individual .md's that is also available in VitePress (and active on our site)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's supposed to indicate when the zoe code was last updated. It might be nice to say what version of code we're documenting.

But yeah... currently, this is just noise.

</div>
</template>
Loading
Loading