m2r2 icon indicating copy to clipboard operation
m2r2 copied to clipboard

Can we include a link in the mdinclude directive

Open SavvyOsive opened this issue 2 years ago • 2 comments

In place of the relative file path to the md in the .. mdinclude:: file directive, is there a way we can provide a link to the md and render the md in the rst.

SavvyOsive avatar Jul 24 '22 20:07 SavvyOsive

@SavvyOsive can you elaborate with an example?

CrossNox avatar Aug 11 '22 15:08 CrossNox

m2r2 converter only renders the md which is provided to it as a file in the mdinclude directive like this

.. mdinclude:: ./md/Readme.md

but we can't provide a remote link of the md like

.. mdinclude:: https://github.com/apache/kafka/blob/trunk/PULL_REQUEST_TEMPLATE.md

It doesn't render the md provided to it as a remote link and gives the following error because it's looking for a file or directory in the local only PFKnD

Is there a way we can render md inside rst by providing a link of the md rather than downloading it on the local and providing a relative path?

@CrossNox

SavvyOsive avatar Sep 18 '22 06:09 SavvyOsive