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

Jump to bottom

Support for pipe character in page links #24

Closed
SimonCockx opened this issue Aug 19, 2020 · 1 comment · Fixed by #42
Closed

Support for pipe character in page links #24

SimonCockx opened this issue Aug 19, 2020 · 1 comment · Fixed by #42
Assignees
@mipatterson
Labels
enhancement New feature request status: released Bug fix or feature request has been released

Comments

@SimonCockx
Copy link

Similar to the pipe character in regular TypeDoc links ({@link Foo | Foo interface}), allowing a pipe in page links would be a great addition to the plugin.

Example usage:

Take a look at the {@page Getting started | getting-started guide}.
@mipatterson mipatterson added the enhancement New feature request label Nov 16, 2020
@mipatterson mipatterson self-assigned this Nov 25, 2020
@mipatterson mipatterson added the status: in progress Work is in progress for the bug or feature label Nov 25, 2020
mipatterson added a commit that referenced this issue Nov 28, 2020
@mipatterson
feat(page-link-parser): add support for defining custom page link text
30b7625 
Add support for defining custom page link text via pipe syntax similar to TypeDoc's type link tag

implement feature request #24
@mipatterson mipatterson linked a pull request Nov 28, 2020 that will close this issue
Add page link pipe syntax support #42
Merged
@mipatterson
Copy link
Owner

This feature is available in release v1.1.0.

@mipatterson mipatterson added status: released Bug fix or feature request has been released and removed status: in progress Work is in progress for the bug or feature labels Nov 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mipatterson mipatterson

Labels
enhancement New feature request status: released Bug fix or feature request has been released
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add page link pipe syntax support mipatterson/typedoc-plugin-pages
2 participants
@mipatterson @SimonCockx