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

Make Markdown flavour explicit on the markdown page #9403

Closed
mlevison opened this issue Sep 13, 2024 · 2 comments · Fixed by #9573
Closed

Make Markdown flavour explicit on the markdown page #9403

mlevison opened this issue Sep 13, 2024 · 2 comments · Fixed by #9573
Labels
good first issue Good for newcomers help wanted Issues looking for someone to run with them! improve documentation Enhance existing documentation (e.g. add an example, improve description)

Comments

@mlevison
Copy link

📚 Subject area/topic

Markdown

📋 Page(s) affected (or suggested, for new content)

https://docs.astro.build/en/guides/markdown-content/

📋 Description of content that is out-of-date or incorrect

The page mentions the default markdown type in passing. It code state explicitly, the default markdown flavour is GitHub Flavoured and then link to the spec.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

@mlevison mlevison added the improve documentation Enhance existing documentation (e.g. add an example, improve description) label Sep 13, 2024
@sarah11918
Copy link
Member

You're right, we do mention this in terms of the plugin that is automatically applied so that Astro follows the spec, but don't prominently display nor link to the spec itself.

We could probably display this prominently by adding to first sentence of the second paragraph:

In Astro, you can author content in Markdown, then render it in .astro components.

In Astro, you can author content in [GitHub Flavored Markdown](https://github.github.com/gfm/), then render it in .astro components. 

Do you think something like this would be helpful? If so, I'd welcome a PR with this addition!

@sarah11918 sarah11918 added the good first issue Good for newcomers label Sep 23, 2024
@mlevison
Copy link
Author

Thanks, that's a great start. Run the experiment and see if it changes how often obtuse Ottawan's make the mistake of asking about it again.

@sarah11918 sarah11918 added the help wanted Issues looking for someone to run with them! label Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Issues looking for someone to run with them! improve documentation Enhance existing documentation (e.g. add an example, improve description)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants