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

Add a New Post Checklist to PRs #1944

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

MTRNord
Copy link
Collaborator

@MTRNord MTRNord commented Jul 18, 2023

This adds a Pull request template to this repo for ensuring the posts don't have common issues that have been noticed over the last few TWIM editions. I am not trying to annoy editors here, but instead help them.

Zola uses CommonMark, while the old Blog used MDX. While both are markdown there is a small difference in some of the syntax especially around autolinking of links. This hopefully helps authors to double-check these things while they develop a muscle memory for the changed syntax.

@HarHarLinks
Copy link
Contributor

there's probably a github action out there that can scan content for things that look like URLs and warn if they're not markdown...

@MTRNord
Copy link
Collaborator Author

MTRNord commented Jul 18, 2023

there's probably a github action out there that can scan content for things that look like URLs and warn if they're not markdown...

Probably but ideally it would be nice if people learn this regardless :) Its going to stay the syntax for the next few years. So it may be good to learn it :)

## New Post Checklist

- [ ] Links are linkified
- [ ] Bare links are surrounded by `<>` (required since Zola follows commonmark strictly)
Copy link
Contributor

@jplatte jplatte Oct 13, 2023

Choose a reason for hiding this comment

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

More like because pulldown_cmark doesn't support auto-detection of bare links (yet): pulldown-cmark/pulldown-cmark#695

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh! Well that's unfortunate. Reading the spec I thought this is actually intentional by the commonmark spec 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants