fix: readme note #2204
fix: readme note #2204
Conversation
| If a plugin does not originate from the [ApeWorX GitHub Organization](https://github.com/ApeWorX?q=ape&type=all), you will get a warning about installing 3rd-party plugins. | ||
| Install 3rd party plugins at your own risk. | ||
| ``` | ||
| > \[!NOTE\] |
There was a problem hiding this comment.
Oh nice! Is this specific to Github markdown, or does it also work with sphinx-markdown?
There was a problem hiding this comment.
This one is specific for Github markdown. I don't think it works the same with sphinx-markdown.
There was a problem hiding this comment.
Remember that this is the quickstart guide for our docs as well
There was a problem hiding this comment.
This will render in the docs like this which I think is still a good way of doing this since it makes it more clear on github about the note and is still clear enough when rendered with sphinx.
There was a problem hiding this comment.
Personally I love the note highlighting we have in the docs now, I would love to have it render in github better but I think the docs rendering takes precedence over github
|
As a side note, I'm very in favor of this type of change with the addition of an extension or plugin that converts the Github alert syntax to the equivalent HTML or directive syntax for Sphinx-flavored markdown (which uses CommonMark) so the docs look right As a reference |
What I did
Note in README wasn't rendering properly.
fixes: #
How I did it
How to verify it
Checklist