Skip to content

Migrate docs to Vitepress #1446

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

Merged
merged 1 commit into from
Nov 19, 2023
Merged

Migrate docs to Vitepress #1446

merged 1 commit into from
Nov 19, 2023

Conversation

drwpow
Copy link
Contributor

@drwpow drwpow commented Nov 19, 2023

Changes

Uses Vitepress for documentation. Why?

  • Better maintainability. Less custom code, more template-y solutions (that are updatable and patchable)
  • Better a11y. Provides great a11y out-of-the-box, including [custom containers]
    (https://vitepress.dev/guide/markdown#custom-containers) that replace bad blockquote abuse
  • Better readability. Clearer anchor links, searching, and better mobile styles
  • Easier contributions. No custom docs code; now it uses a community standard with great support
  • Better styling. It just looks better than the old custom docs code.

Docs-only change; no code changes.

How to Review

(Note: the Cloudflare preview will fail at first because this needs to merge before that is switched over)

Checklist

N/A

Copy link

changeset-bot bot commented Nov 19, 2023

⚠️ No Changeset found

Latest commit: e46214c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@drwpow drwpow merged commit 5f430e3 into main Nov 19, 2023
@drwpow drwpow deleted the vitepress branch November 19, 2023 03:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant