Add a New Post Checklist to PRs #1944
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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... |
… indentations work
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 :) |
jplatte
reviewed
Oct 13, 2023
| ## New Post Checklist | ||
|
|
||
| - [ ] Links are linkified | ||
| - [ ] Bare links are surrounded by `<>` (required since Zola follows commonmark strictly) |
There was a problem hiding this comment.
More like because pulldown_cmark doesn't support auto-detection of bare links (yet): pulldown-cmark/pulldown-cmark#695
There was a problem hiding this comment.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.