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.

Sign up for GitHub

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

fix(core): preserve anchors in project document links #760

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −1
Open

fix(core): preserve anchors in project document links #760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-parts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ export function getCommentParts(
} else {
const fileName = this.page.project.files.getName(part.target);
if (fileName) {
url = this.getRelativeUrl(`_media/${fileName}`);
const anchor = part.targetAnchor ? `#${part.targetAnchor}` : '';
url = this.getRelativeUrl(`_media/${fileName}${anchor}`);
}
}

Expand Down
1 change: 1 addition & 0 deletions packages/typedoc-plugin-markdown/test/fixtures/src/comments/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
* Relative Links:
*
* - [Relative Document](../../PROJECT_DOC_1.md)
* - [Relative Document With Anchor](../../PROJECT_DOC_1.md#anchor)
*
* Relative Image Links:
*
Expand Down
1 change: 1 addition & 0 deletions packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ External links:
Relative Links:

- [Relative Document](_media/PROJECT_DOC_1.md)
- [Relative Document With Anchor](_media/PROJECT_DOC_1.md#anchor)

Relative Image Links:

Expand Down