Markdown Recipe

[Jothsa]

What kind of changes does this PR include?

• New or updated content

Description

• Closes Pull out Markdown plugin examples into a recipe #2864
• What does this PR change? Give us a brief description. I moved the add reading time example from the Markdown & MDX guide to a new recipe.

Let me know if I should do any other examples from the page.

[netlify]

✅ Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	da3fed3
🔍 Latest deploy log	https://app.netlify.com/sites/astro-docs-2/deploys/64691052b93072000844c6fe
😎 Deploy Preview	https://deploy-preview-3270--astro-docs-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[sarah11918]

Hey this looks great @Jothsa! I'm really excited for this!

Just a couple of general changes I think we can make to improve the page, then I'll edit more closely:

• There aren't any prerequisites really, because Astro has remark support built in. You don't have to first install remark and THEN choose a remark plugin. So, I would say more like Prerequisites are none, saying that Astro has built-in support for adding remark plugins (with the same link).
• I know you've copied the existing text, but now that I see it on its own like this, do you think that it makes more sense to show adding to config BEFORE using it in a file? (That's the beauty of pulling these things out and making them feature content on their own recipe page! Rather than getting buried on a long page, we can really focus on them!) It seems to me the logical order of actions should be:
  • install
  • configure
  • use

Can you try recrafting the existing page based on the above, then I'll do a bit of editing, too?

[Jothsa]

Thanks for the great feedback, @sarah11918! I'll get on it later this morning

[Jothsa]

@sarah11918, it's my understanding that the plugin is created in a file created by the user. Personally, I think it makes more sense to create the file/plugin and then add it to the config. Otherwise, wouldn't you be saying, create a blank file, add it to your config, and then add the plugin code to the file? I'm fine either way, but just wanted to mention it.

[sarah11918]

Oh, I get you now. Agreed! Good call! Let's leave that as is, and just make sure prerequisites makes sense. 🙌

[Jothsa]

This needs edits as well 😅 Should have it done by Monday

[sarah11918]

This is looking amazing, @Jothsa! It feels like such a clean read!

I added a couple of suggestions, mostly for standardizing things: packages/properties etc should all use the code formatting when referring to them by name (instead of e.g. talking "about" the title of your page in a paragraph), and Markdown is always capitalized in prose. :)

I also thought we could add a little more context around step 4. See what you think!

[Jothsa]

Thanks!

[sarah11918]

Looking good! I just checked the Netlify deploy preview, and can you see that the content isn't indented inside all the steps like the other recipes are? e.g. if you check another docs page like https://deploy-preview-3270--astro-docs-2.netlify.app/en/recipes/build-forms-api/ you'll see the content is indented so that the numbered steps create a new left margin.

This should just be a matter of indenting content within each step, but check another recipe page to be sure. Once we get the formatting to match the others, I think this is good to go! 🥳

[Jothsa]

Whoops. Thanks! Should be fixed now

[sarah11918]

Let's do this!