Docs not rendered in Markdown correctly

[isabelizimm]

When looking at the docs, the Markdown syntax is not rendered in GitHub. Maybe it is hosted on GHPages or another location where it is rendered as expected and the README link needs to be updated?

This is a snippet of what I am seeing when I follow the README link for docs: ⬇️

---

[tdstein]

Hey @isabelizimm - the snippets bit is particular to mkdocs. Checkout https://github.com/rstudio/rsconnect-jupyter/blob/master/docs/README.md

[tdstein]

And the public docs are available here: https://docs.posit.co/rsconnect-jupyter/

[hronrade]

@tdstein I think Isabel was flagging the GH docs tagged in the master README here - which has markdown syntax throughout. Do we need to link to the GH version of docs there? Maybe easiest solution is to only point to public doc link, unless there's a way to have GH pull a different version without markdown syntax? Maybe more of a question for @aronatkins or @kelli-rstudio

https://github.com/rstudio/rsconnect-jupyter/blob/master/README.md https://github.com/rstudio/rsconnect-jupyter/blob/master/docs/docs/index.md

[tdstein]

Ah, I see.

In this case, the README.md is primarily utilized by users of PyPI https://pypi.org/project/rsconnect-jupyter/

It makes sense to remove the direct link to GitHub and leave the link to the public documentation.

[hronrade]

Awesome, thanks! I'll grab this then :)

[hronrade]

Accidentally pushed to Main instead of branch - @mmarchetti reviewed/approved https://github.com/rstudio/rsconnect-jupyter/commit/5a0fcaa1c1a75bc3d3d6f3bbe766bbdb93b1a8da closing this as complete