grim/hgwebplus

36b6003e8b84
Parents 4605f497eff1
Children 37c96b2be81d
Update the README for the markdown renderer changes.
  • +6 -10
    README.md
  • --- a/README.md Sun May 17 02:41:51 2020 -0500
    +++ b/README.md Sun May 17 03:09:49 2020 -0500
    @@ -25,18 +25,14 @@
    The most notable feature is that a new template keyword named `readme` has been
    added. Since this is a keyword, it can be used in any template. This keyword
    will look for files named `README.md`, `README.txt`, and `README` in a case
    -insensitive fashion, and return their contents rendered to HTML.
    -
    -**Please note, that at this time, images do not yet work.**
    +insensitive fashion, and return their contents rendered with a Markdown
    +renderer.
    -The Markdown rendering uses [cmarkgfm](https://pypi.org/project/cmarkgfm/) to
    -support GitHub Flavored Markdown. However, there is no styling associated with
    -this render. To do that, I recommend you use [sindresorhus's
    +The Markdown rendering uses [mistune](https://pypi.org/project/mistune/) to
    +support Markdown. However, there is no styling associated witha this render.
    +To do that, I recommend you use [sindresorhus's
    github-markdown-css](https://github.com/sindresorhus/github-markdown-css/) in
    -your theme and addjust it accordingly.
    -
    -For plain text, the HTML rendering is just literally prefixing line endings
    -with a `<br/>`.
    +your theme and adjust it accordingly.
    ## Gravatar Support