feat(vitepress): updates site to use vitepress

0xpatrickdev commented 5 months ago

closes: #972 refs: #609

Summary

vitepress is the successor to vuepress (maintence mode). I looked into it yesterday in search of a better site search and came to realize the apis are very similar.
uses default theme from vitepress, with agoric branded colors
search now powered by minisearch, client-size full-text search. Previously, we were only searching document titles.

To Do

[x] redirect logic. partially implemented, need to account for external redirects and subdomains
- relying on Cloudflare for external redirects (_redirects_)
[x] some broken links, i think mostly as a result of the above. remove ignoreDeadLinks: true
[x] index.md / home styles? ~~Think there's room for improvements here?~~ Preserving existing styles for now: 4bcb1ae
[x] search: show more info like here
[x] 3rd level menus?. These now appear on the right side. If we want to preserve them on the left side nav, we can do something like bedd10aa76ab0ec3a1ef192cc824d16ba51a53ff. Seems we don't need to do anything here, streamlined view is preferred.
[x] sitemap - is there an existing sitemap?
- added a sitemap in e963c1f
[x] dead code removal ~~mlc-config.json~~, enhanceApp.js
- ~~I would like to to understand #882 and #888 better to see if we can remove enhanceApp.js.~~
- [x] move inline scripts to .vitepress/config.mjs (formerly, .vuepress/config.js) see 5983738
[x] redirects see comment see c69ed8a
[x] mobile styles see comment see 5358d21

cloudflare-pages[bot] commented 5 months ago

Deploying documentation with Cloudflare Pages

Latest commit:	`b1eed18`
Status:	✅ Deploy successful!
Preview URL:	https://65175600.documentation-7tp.pages.dev
Branch Preview URL:	https://pc-vitepress.documentation-7tp.pages.dev

View logs

dckc commented 5 months ago

cloudflare failure looks like:

13:40:16.942 Error: Output directory "main/.vuepress/dist" not found.

0xpatrickdev commented 5 months ago

cloudflare failure looks like:

13:40:16.942 Error: Output directory "main/.vuepress/dist" not found.

I think the CI job is managed elsewhere (i.e., not source control)? Changing .vuepress -> .vitepress should make it pass. We can do this once everything is reviewed as it would after other PR's

dckc commented 5 months ago

also fixes #609 ?

0xpatrickdev commented 5 months ago

Deployed something here for the interim: https://65cac5889558bd35423c70e1--beautiful-lolly-46c6b2.netlify.app/

I used the output of yarn docs:build + _redirects. Netlfiy and Cloudflare seem to have the same _redirects structure.

0xpatrickdev commented 5 months ago

also fixes #609 ?

I did not tackle eslint in this, but can update the PR body with refs. #965 seems like it also contributes to #609

dckc commented 4 months ago

horizontal margins look goofy... including a scrollbar. important

0xpatrickdev commented 4 months ago

To merge this, we need to change the Build Output Directory in the cloudflare dash from /main/.vuepress/dist to /dist. The yarn docs:build-cf command (which copies _redirects into /dist) should stay the same.

We could make this deploy from /main/.vuepress/dist, but seems worthwhile to use a more generic /dist.

Agoric / documentation