bxantus / mdoc

Markdown documentation viewer for Visual Studio Code
MIT License
4 stars 0 forks source link

Remote file is rendered weirdly #9

Closed thany closed 6 months ago

thany commented 3 years ago

When linking to, or putting in the index.md file a remote file, which would be a documentation file on Github, it renders like this:

image

That ain't too useful, if we decide on online documentation (versus local).

When I open the same file in my browser, I get to see the linked documentation file as intended.

bxantus commented 3 years ago

You've probably linked to a generated html view of the documentation (at least based on the screenshot I guess this is the case). You should always link to the raw URL (pointing to the markdown file content). If this isn't the case please provide me with the concrete example (link) to check it more thoroughly.

Please check if this solves the issue.