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

Use Markdoc on the website #7786

Merged
merged 10 commits into from
Aug 16, 2022
Merged

Use Markdoc on the website #7786

merged 10 commits into from
Aug 16, 2022

Conversation

emmatown
Copy link
Member

@emmatown emmatown commented Aug 11, 2022

This PR replaces MDX with Markdoc for the docs portion of the website. It does not actually remove MDX from the website because I skipped converting the updates/releases sections to use Markdoc since they do weirder things and they'll likely be going away soon, it didn't seem worthwhile converting them.

The reasoning behind this is so that we can easily statically analyze our docs (It's impractical to do that on MDX since it's literally code that could do anything) to get all the headings for a table of contents and etc. while preserving the ability to express more custom things that can't be represented with just Markdown

@changeset-bot
Copy link

changeset-bot bot commented Aug 11, 2022

⚠️ No Changeset found

Latest commit: c5c6aa1

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

@vercel
Copy link

vercel bot commented Aug 11, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
keystone-next-docs ✅ Ready (Inspect) Visit Preview Aug 16, 2022 at 5:36AM (UTC)

@codesandbox-ci
Copy link

codesandbox-ci bot commented Aug 11, 2022

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit c5c6aa1:

Sandbox Source
@keystone-6/sandbox Configuration

@vercel vercel bot temporarily deployed to Preview August 11, 2022 05:17 Inactive
@vercel vercel bot temporarily deployed to Preview August 11, 2022 05:40 Inactive
@vercel vercel bot temporarily deployed to Preview August 11, 2022 06:46 Inactive
@vercel vercel bot temporarily deployed to Preview August 11, 2022 07:09 Inactive
@vercel vercel bot temporarily deployed to Preview August 12, 2022 00:20 Inactive
@vercel vercel bot temporarily deployed to Preview August 12, 2022 04:42 Inactive
@emmatown emmatown force-pushed the markdoc branch 7 times, most recently from d3f1f52 to 29977d2 Compare August 12, 2022 05:17
@vercel vercel bot temporarily deployed to Preview August 12, 2022 05:22 Inactive
@vercel vercel bot temporarily deployed to Preview August 12, 2022 05:52 Inactive
@vercel vercel bot temporarily deployed to Preview August 12, 2022 06:07 Inactive
@vercel vercel bot temporarily deployed to Preview August 12, 2022 06:50 Inactive
@vercel vercel bot temporarily deployed to Preview August 16, 2022 01:31 Inactive
@vercel vercel bot temporarily deployed to Preview August 16, 2022 04:15 Inactive
@vercel vercel bot temporarily deployed to Preview August 16, 2022 04:29 Inactive
@vercel vercel bot temporarily deployed to Preview August 16, 2022 05:36 Inactive
@emmatown emmatown marked this pull request as ready for review August 16, 2022 05:42
@emmatown emmatown requested a review from a team August 16, 2022 05:42
@dcousens dcousens merged commit c0165f3 into main Aug 16, 2022
@dcousens dcousens deleted the markdoc branch August 16, 2022 07:48
@emmatown emmatown mentioned this pull request Aug 23, 2022
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.

2 participants