docs.nestjs.com icon indicating copy to clipboard operation
docs.nestjs.com copied to clipboard

docs: convert absolute paths to relative paths

Open bombard1004 opened this issue 1 year ago • 3 comments

PR Checklist

Please check if your PR fulfills the following requirements:

  • [x] The commit message follows our guidelines: https://github.com/nestjs/docs.nestjs.com/blob/master/CONTRIBUTING.md

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
  • [x] 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
  • [x] No

Other information

bombard1004 avatar Aug 01 '24 03:08 bombard1004

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

kamilmysliwiec avatar Aug 01 '24 06:08 kamilmysliwiec

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.

bombard1004 avatar Aug 03 '24 04:08 bombard1004

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).

kamilmysliwiec avatar Aug 05 '24 11:08 kamilmysliwiec