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

docs: convert absolute paths to relative paths #3068

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

bombard1004
Copy link

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Docs
  • Other... Please describe:

What is the current behavior?

Issue Number: closes #3067

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@kamilmysliwiec
Copy link
Member

We intentionally use absolute paths for links that should open in a new browser tab (with target = blank)

@bombard1004
Copy link
Author

bombard1004 commented Aug 3, 2024

Hi, thank you for sharing the context.

After further investigation, I’ve found that the common practice is to append {:target="_blank"} to Markdown links to open them in a new tab. Unfortunately, it appears that the markedjs library does not support parsing this syntax.

I also noticed that the document mixes Markdown links and HTML anchor tags. Given this, I’d like to suggest using HTML anchor tags for internal links that need to open in a new tab, allowing the use of target="_blank". I would appreciate your thoughts on this approach.

@kamilmysliwiec
Copy link
Member

Are we sure this is worth the effort though? We don't plan to add any translations to the docs any time soon (and possibly ever).

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

Successfully merging this pull request may close these issues.

Convert absolute paths to relative paths in documentation
2 participants