Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for internal links #24

Open
ediordna opened this issue Oct 6, 2023 · 1 comment
Open

Add support for internal links #24

ediordna opened this issue Oct 6, 2023 · 1 comment

Comments

@ediordna
Copy link

ediordna commented Oct 6, 2023

Add support for internal links

At the moment, links to headings inside the file aren't working, see following example:

## Getting Started

Lorem Ipsum 

## Development

For xyz see section [Getting Started](#getting-started)

I would expect sphinx-mdinclude to generate a working internal link to the heading Getting Started. Instead, just the plain text inside of the [] brackets is displayed in the Sphinx Docs.

@stephane-caron
Copy link

I'm facing the same issue. GitHub readmes have internal references generated automatically, and my readme uses them.

Alternatively, if there would be a way to explicitly write down the references for sphinx-mdinclude (invisible to GitHub readers) that would work too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants