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

Broken internal links #219

Open
luraess opened this issue Feb 19, 2025 · 2 comments
Open

Broken internal links #219

luraess opened this issue Feb 19, 2025 · 2 comments

Comments

@luraess
Copy link

luraess commented Feb 19, 2025

I am having an issue with respect to internal links.

Following the Vite doc, https://vitepress.dev/guide/markdown#internal-links, I am trying to link from /getting_started/introduction.md to /concepts/bc.md in https://ptsolvers.github.io/Chmy.jl/dev/getting_started/introduction#Boundary-Conditions.

I am thus implementing it as
initial or [boundary conditions](../concepts/bc.md)
but upon building, this results in
initial or <a href="./concepts/bc">boundary conditions</a>
which in turns returns a 404.

Am I doing something wrong or is there an issue with parsing internal links?

@lazarusA
Copy link
Collaborator

Indeed. The issue is here

function render(io::IO, mime::MIME"text/plain", node::Documenter.MarkdownAST.Node, link::Documenter.PageLink, page, doc; kwargs...)
and here
# Documenter.jl local links

The first one is going into the else statement, and removing the relative path, and the second one is the one supposed to be use for local links? @asinghvi17 , these don't work as expected. Not sure how to get and preserve the relative paths here :( .

@asinghvi17
Copy link
Collaborator

asinghvi17 commented Feb 19, 2025

Hmm, maybe I got the types wrong. Would have to check, maybe with an MWE in a PR to this repo so we can verify it works...

Am slammed today but will look at this tomorrow.

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

3 participants