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

Link not working within and after <ul> or <ol> tags #2103

Closed
chrisgdt opened this issue Nov 14, 2022 · 6 comments
Closed

Link not working within and after <ul> or <ol> tags #2103

chrisgdt opened this issue Nov 14, 2022 · 6 comments
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@chrisgdt
Copy link

chrisgdt commented Nov 14, 2022

Search terms

Indent by itemize or enumerate, <ol> <ul> tags, link parsing into markdown and not HTML ref.

Expected Behavior

Having {@link ...} tags working everywhere in the doc.

Actual Behavior

Inside <ol> tag, no link is working, not even after </ol>. Everything is parsed into markdown so it's not working in the HTML code.

Steps to reproduce the bug

Simply run typedoc --out docs/ --tsconfig ./tsconfig.json ./test.ts with :

tsconfig.json
{
  "include": [
    "test.ts"
  ]
}
test.ts
/**
 * Write my documentation with some enumerate.
 * Before, the link to {@link myFunction} is working and {@link https://www.google.com | url} too.
 * <ol>
 *   <li>But within `ol` or `ul` tags, it's not {@link myFunction | working}.</li>
 *   <li>Not even url like {@link https://www.google.com}.</li>
 * </ol>
 * After, it's not working anymore : {@link myFunction} ; {@link https://www.google.com | url}.
 */
function myFunction () {
  console.log("hello world!");
}

The result is:
ss+(2022-11-14+at+02 25 10)

Notice that there is no warning Failed to resolve link [...].

Environment

  • Typedoc version: 0.23.21
  • TypeScript version: 4.8.4
  • Node.js version: 16.17.0 (not used)
  • OS: Windows version 10.0.19043 Build 19043
@chrisgdt chrisgdt added the bug Functionality does not match expectation label Nov 14, 2022
@chrisgdt chrisgdt changed the title Link not working within and after <ul> or <ol> tags. Link not working within and after <ul> or <ol> tags Nov 14, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 14, 2022

TypeDoc resolved the link, but marked didn't render it, because markdown isn't allowed within block level html elements.

This function should be producing <a> tags instead of markdown links.

@Gerrit0 Gerrit0 added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Nov 14, 2022
@KlausMikhaelson
Copy link

Hey @chrisgdt is this issue still open to work on ? if yes than would love to work on it !

@chrisgdt
Copy link
Author

@KlausMikhaelson Yes of course, I opened it today ! I currently don't have the time to dive into the code and try to PR it myself.

@Yasir761
Copy link

Can you assign me this issue, I would love to work on this.

@KlausMikhaelson
Copy link

Hey @Yasir761 I already asked him and rn working on it, there should be other issues open as well would really appreciate if you can check them out.
Thank you !

@Yasir761
Copy link

@KlausMikhaelson It's ok brother.
Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

No branches or pull requests

4 participants