Update integrations to MDX syntax #5978

ElianCodes · 2023-12-28T14:56:13Z

Description (required)

Updates all integration guides to use MDX & Expressive Code syntax, instead of regular MD.

Co-authored-by: HiDeoo <HiDeoo@users.noreply.github.com> Co-authored-by: Reuben Tier <TheOtterlord@users.noreply.github.com> Co-authored-by: Jeffrey Johnston <Coffee-Nerd@users.noreply.github.com> Co-authored-by: Atharva Pise <atharvapise19@gmail.com> Co-authored-by: Luiz Ferraz <luiz@lferraz.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

vercel · 2023-12-28T14:56:20Z

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

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview		Dec 30, 2023 6:06pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
docs-i18n	⬜️ Ignored (Inspect)	Visit Preview		Dec 30, 2023 6:06pm

sarah11918 · 2023-12-28T16:48:32Z

@VoxelMC We missed you on Talking and Doc'ing today! This PR is "done" but needs careful reviewing! I'm sure there's stuff missed, or still to decide. The link to the HackMD explains what we did. Care to take a look over this one?

VoxelMC · 2023-12-28T17:02:32Z

@VoxelMC We missed you on Talking and Doc'ing today! This PR is "done" but needs careful reviewing! I'm sure there's stuff missed, or still to decide. The link to the HackMD explains what we did. Care to take a look over this one?

Yes! Definitely. I will be available to later today, looking forward to it!

alexanderniebuhr

Added some comments for the Cloudflare adapter. Except one I don't think those are blocking, but I would love to get solved, why the ins seem not to work for the one block.

src/content/docs/en/guides/integrations-guide/cloudflare.mdx

VoxelMC · 2023-12-28T19:59:17Z

Slowly working on a review to (hopefully) use Expressive Code to full capacity! Hope to have it done soon :)

src/content/docs/en/guides/integrations-guide/alpinejs.mdx

src/content/docs/en/guides/integrations-guide/cloudflare.mdx

CBID2

Just added some suggestions.

at-the-vr

Got some suggestions for the integrations I took yesterday and 1 minor nit ⬇️

Certain fragments in the modified files use ```sh and others use ```shell, both of them work 💯 but thought to point it out. Example: install/auto uses "```shell" in its fragments

src/content/docs/en/guides/integrations-guide/vercel.mdx

src/content/docs/en/guides/integrations-guide/vue.mdx

src/content/docs/en/guides/integrations-guide/mdx.mdx

src/content/docs/en/guides/integrations-guide/netlify.mdx

VoxelMC

Absolutely fantastic work to everyone who worked on this! Elian, Otterlord, HiDeoo, Atharva, Sarah, Fryuni, and Coffee-Lord! And all of the reviewers so far, too.

I truly feel like the integration docs are FAR more Expressive!~

Anyways, I left some comments about potential changes to expressive-ness, and some formatting fixing (if they haven't been rectified already).

src/content/docs/en/guides/integrations-guide/markdoc.mdx

src/content/docs/en/guides/integrations-guide/vercel.mdx

src/content/docs/en/guides/integrations-guide/tailwind.mdx

src/content/docs/en/guides/integrations-guide/cloudflare.mdx

alexanderniebuhr

Added some comments :re the Netlify adapter

src/content/docs/en/guides/integrations-guide/netlify.mdx

sarah11918 · 2023-12-29T12:30:24Z

I wish I could @everyone here in a PR!

Thank you, "everyone" for such care and attention! I'm going to:

commit the suggestions I can and resolve conversations
leave the comments OPEN for things that could not be edited/suggested because you couldn't change that part of the file
Edit the file directly and add the open comments so I can resolve more of them
Let @VoxelMC make a PR to this branch to standardize the opening / Install sections
... see where we are by then. 😅

Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>

Co-authored-by: Atharva Pise <atharvapise19@gmail.com> Co-authored-by: voxel!() <voxelmc@hotmail.com>

…g options

Co-authored-by: HiDeoo <HiDeoo@users.noreply.github.com> Co-authored-by: Reuben Tier <TheOtterlord@users.noreply.github.com> Co-authored-by: Jeffrey Johnston <Coffee-Nerd@users.noreply.github.com> Co-authored-by: Atharva Pise <atharvapise19@gmail.com> Co-authored-by: Luiz Ferraz <luiz@lferraz.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com> Co-authored-by: voxel!() <voxelmc@hotmail.com> Co-authored-by: Alexander Niebuhr <45965090+alexanderniebuhr@users.noreply.github.com> Co-authored-by: Favour Okoh <87978245+Favourz1@users.noreply.github.com>

ElianCodes added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Dec 28, 2023

ElianCodes self-assigned this Dec 28, 2023

fix: open tag before closing

6cc2c4e

vercel bot deployed to Preview – docs December 28, 2023 15:05 View deployment

sarah11918 marked this pull request as ready for review December 28, 2023 16:49

sarah11918 added the help - leave feedback Let's crowd source this one! Looking for comments, suggestions, LGTMs! label Dec 28, 2023

alexanderniebuhr self-requested a review December 28, 2023 18:26

alexanderniebuhr requested changes Dec 28, 2023

View reviewed changes

sarah11918 reviewed Dec 28, 2023

View reviewed changes

src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated Show resolved Hide resolved

sarah11918 reviewed Dec 28, 2023

View reviewed changes

src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated Show resolved Hide resolved

Quick Cloudflare fixes from Alex's feedback

84c9af1

vercel bot deployed to Preview – docs December 28, 2023 19:57 View deployment

CBID2 reviewed Dec 28, 2023

View reviewed changes

src/content/docs/en/guides/integrations-guide/alpinejs.mdx Show resolved Hide resolved

CBID2 reviewed Dec 28, 2023

View reviewed changes

src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated Show resolved Hide resolved

CBID2 reviewed Dec 28, 2023

View reviewed changes

at-the-vr reviewed Dec 29, 2023

View reviewed changes

VoxelMC reviewed Dec 29, 2023

View reviewed changes

alexanderniebuhr reviewed Dec 29, 2023

View reviewed changes

src/content/docs/en/guides/integrations-guide/netlify.mdx Show resolved Hide resolved

src/content/docs/en/guides/integrations-guide/netlify.mdx Outdated Show resolved Hide resolved

src/content/docs/en/guides/integrations-guide/netlify.mdx Show resolved Hide resolved

Favourz1 reviewed Dec 29, 2023

View reviewed changes

src/content/docs/en/guides/integrations-guide/netlify.mdx Show resolved Hide resolved

try steps below first, then report problems

b93d550

Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>

vercel bot deployed to Preview – docs December 29, 2023 12:38 View deployment

Apply suggestions from code review

336c577

Co-authored-by: Atharva Pise <atharvapise19@gmail.com> Co-authored-by: voxel!() <voxelmc@hotmail.com>

vercel bot deployed to Preview – docs December 29, 2023 12:55 View deployment

resolve other comments

2bfa3a4

Merge branch 'main' into update-integrations

82a7c63

vercel bot had a problem deploying to Preview – docs December 30, 2023 16:51 Failure

remove second video

fd845ec

vercel bot deployed to Preview – docs December 30, 2023 17:08 View deployment

sarah11918 added 3 commits December 30, 2023 17:18

add since components

071e994

update adapter manual instructions to mention both on-demand renderin…

5e3a145

…g options

update old style note

5e9403e

vercel bot deployed to Preview – docs December 30, 2023 17:42 View deployment

unify adapter intros

be0a51f

vercel bot deployed to Preview – docs December 30, 2023 18:06 View deployment

sarah11918 merged commit 9ecadb8 into main Dec 30, 2023
8 checks passed

sarah11918 deleted the update-integrations branch December 30, 2023 18:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update integrations to MDX syntax #5978

Update integrations to MDX syntax #5978

ElianCodes commented Dec 28, 2023

vercel bot commented Dec 28, 2023 •

edited

Loading

sarah11918 commented Dec 28, 2023

VoxelMC commented Dec 28, 2023

alexanderniebuhr left a comment

VoxelMC commented Dec 28, 2023

CBID2 left a comment

at-the-vr left a comment

VoxelMC left a comment

alexanderniebuhr left a comment

sarah11918 commented Dec 29, 2023

Update integrations to MDX syntax #5978

Update integrations to MDX syntax #5978

Conversation

ElianCodes commented Dec 28, 2023

Description (required)

vercel bot commented Dec 28, 2023 • edited Loading

sarah11918 commented Dec 28, 2023

VoxelMC commented Dec 28, 2023

alexanderniebuhr left a comment

Choose a reason for hiding this comment

VoxelMC commented Dec 28, 2023

CBID2 left a comment

Choose a reason for hiding this comment

at-the-vr left a comment

Choose a reason for hiding this comment

VoxelMC left a comment

Choose a reason for hiding this comment

alexanderniebuhr left a comment

Choose a reason for hiding this comment

sarah11918 commented Dec 29, 2023

vercel bot commented Dec 28, 2023 •

edited

Loading