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

docs: 📝 add why Markdown post #167

Merged
merged 4 commits into from
Mar 10, 2025
Merged

docs: 📝 add why Markdown post #167

merged 4 commits into from
Mar 10, 2025

Conversation

lwjohnst86
Copy link
Member

Description

Doing some work for DP-Next and thought it would be good to link to a decision post for why we decide on Markdown.

Closes #54

This PR needs an in-depth review.

Checklist

  • Ran spell-check
  • Formatted Markdown
  • Ran just run-all

@lwjohnst86 lwjohnst86 requested a review from a team as a code owner February 28, 2025 15:28
K-Beicher
K-Beicher previously approved these changes Mar 3, 2025
Co-authored-by: Kris Beicher <112945740+K-Beicher@users.noreply.github.com>
@signekb
Copy link
Member

signekb commented Mar 6, 2025

I’ve started reviewing this and will finish it tomorrow 🌱

Copy link
Member

@signekb signekb left a comment

Choose a reason for hiding this comment

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

Nice 👍 I have added some suggestions and questions ✨

Comment on lines 82 to 85
- Because of it's ease of use, there are some more powerful features
that are not implemented in the original Markdown syntax, so
extensions are needed to use features that may be needed in some
cases.
Copy link
Member

Choose a reason for hiding this comment

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

Oooo, what kind of features are you referring to here?

format converter in Pandoc. We also use [Quarto](/why-quarto/index.qmd)
for creating websites and other output, which is built on top of
Pandoc's Markdown. Through Quarto we have access to many powerful
features that make up for Markdown's less powerful features.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe add a “such as” with examples of the features we get access to with Quarto.

Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com>
@lwjohnst86 lwjohnst86 requested a review from signekb March 7, 2025 16:37
@signekb signekb merged commit e2f0dcf into main Mar 10, 2025
@signekb signekb deleted the docs/why-markdown branch March 10, 2025 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Write a Why Markdown decision post
3 participants