[go: nahoru, domu]
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.

Sign up for GitHub

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

Jump to bottom

markdown plugin changes #8728

Merged
merged 3 commits into from
Jul 4, 2024
Merged

markdown plugin changes #8728

merged 3 commits into from
Jul 4, 2024

Conversation

gllrmzndm
Copy link
Contributor

Description (required)

Added an example of how the plugin works.

English

Related issues & labels (optional)

  • Closes #
  • Suggested label:

@vercel Vercel
Copy link
vercel bot commented Jul 4, 2024 •
edited
Loading

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

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Jul 4, 2024 11:19am

@astrobot-houston
Copy link
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 Vercel 🥳

  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
Contributor
astrobot-houston commented Jul 4, 2024 •
edited
Loading

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.

sarah11918
sarah11918 approved these changes Jul 4, 2024
View reviewed changes
Copy link
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 for contributing this addition to docs, @gllrmzndm ! All I was hoping for was to show a config setting in the example in place, so that if readers did try to copy it, they'd get something that worked out of the box.

I appreciate the full example, but I think we can achieve the same thing just by not showing a plugin that requires configuration without any config. I also think this makes it obvious that if they don't like the default behaviour this produces, they can go look up remarkToc in its own docs and adjust settings.

I'm happy to have a more complete example here, and also happy to welcome you to Team Docs! 🥳

@sarah11918 sarah11918 added improve documentation Enhance existing documentation (e.g. add an example, improve description) Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! labels Jul 4, 2024
@sarah11918 sarah11918 merged commit c64eb1c into withastro:main Jul 4, 2024
8 checks passed
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Jul 4, 2024
@thomasbnt
i18n(fr): Add guides/markdown-content.mdx from withastro#8728
1430714 
Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>
@thomasbnt thomasbnt mentioned this pull request Jul 4, 2024
Merged
@Nin3lee Nin3lee mentioned this pull request Jul 5, 2024
Merged
@jsparkdev jsparkdev mentioned this pull request Jul 5, 2024
Merged
yanthomasdev added a commit that referenced this pull request Jul 8, 2024
@thomasbnt @yanthomasdev
i18n(fr): Add guides/markdown-content.mdx from #8728 (#8729)
e8304fa 
* i18n(fr): Add `guides/markdown-content.mdx` from #8728

Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>

* i18n(fr): Fix broken reference links in Markdown content guide from #8749

Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>

---------

Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sarah11918 sarah11918 sarah11918 approved these changes

Assignees
No one assigned
Labels
improve documentation Enhance existing documentation (e.g. add an example, improve description) Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@gllrmzndm @astrobot-houston @sarah11918