Update README.md to be explicit about not using in md. #81
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
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.
It wasn't clear to me in the documentation that the shortcode and file markup wouldn't work in a
.mdmarkdown file. Trying to do so doesn't throw a specific error, just makes it an HTML file at{site base}/sitemap/index.html, so this is easy to miss. It's especially easy to miss because previous versions of the plugin and/or eleventy allowed you to put it in a markdown file and have it work properly. I think it is important to make explicit to help make sure folks, especially upgraders, do not make this error.