Skip to content

Update markdown-content.mdx#9074

Merged
yanthomasdev merged 2 commits into
withastro:mainfrom
yuedanlabs:patch-1
Aug 14, 2024
Merged

Update markdown-content.mdx#9074
yanthomasdev merged 2 commits into
withastro:mainfrom
yuedanlabs:patch-1

Conversation

@yuedanlabs
Copy link
Copy Markdown
Contributor

fix Markdown plugins remarkPlugins example code error for remarkToc usage

Description (required)

there is an error for Markdown plugins remarkPlugins example code about remarkToc usage

fix code as bellow:

import { defineConfig } from 'astro/config';
import remarkToc from 'remark-toc';
import { rehypeAccessibleEmojis } from 'rehype-accessible-emojis';

export default defineConfig({
  markdown: {
    // Applied to .md and .mdx files
-   remarkPlugins: [remarkToc, { heading: 'toc', maxDepth: 3 }],
+   remarkPlugins: [ [remarkToc, { heading: 'toc', maxDepth: 3 } ] ],
    rehypePlugins: [rehypeAccessibleEmojis],
  },
});

Related issues & labels (optional)

  • Closes #
  • Suggested label:

First-time contributor to Astro Docs?

yes

fix Markdown plugins remarkPlugins example code error for remarkToc usage
@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 13, 2024

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 841737b
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/66bce5e5af1171000809777c
😎 Deploy Preview https://deploy-preview-9074--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@astrobot-houston
Copy link
Copy Markdown
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented Aug 13, 2024

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en guides/markdown-content.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for catching this! We appreciate you taking the time to come fix this, and are happy to welcome you to Team Docs! 🥳

@sarah11918 sarah11918 added code snippet update Updates a code sample: typo, outdated code etc. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! labels Aug 14, 2024
Copy link
Copy Markdown
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good job @yuedanlabs! 💜

@yanthomasdev yanthomasdev merged commit be56c54 into withastro:main Aug 14, 2024
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Aug 14, 2024
dreyfus92 added a commit that referenced this pull request Aug 15, 2024
Apply changes from #9074

Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code snippet update Updates a code sample: typo, outdated code etc. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants