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

[api-documenter] Processing links inside of tables not working reliably in jekyll #4792

Open
richtera opened this issue Jun 18, 2024 · 0 comments

Comments

@richtera
Copy link

richtera commented Jun 18, 2024

Summary

I am using the plain api-documenter markdown command line and processing the output with github pages' jekyll processing.
This seems to work pretty well except for a couple of weeks now it's unable to correctly detect the entrypoint links into the docs.
So rather than showing a table with links it's showing the undecoded markdown.

This looks like this

<table><thead><tr><th>

Package


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[@lukso/data-provider-base](/tools-data-providers/data-provider-base.html)


</td><td>


</td></tr>
.
.
.
</tbody></table>

here is the current URL this is running under https://lukso-network.github.io/tools-data-providers/

The compiled "markdown" file contains

<table><thead><tr><th>

Package


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[@lukso/data-provider-base](./data-provider-base.md)


</td><td>
.
.
.

meaning that unless the final jekyll markdown processor understood markdown within html tags this is not going to work.

Repro steps

All I have to do is execute api-extractor and api-documenter and deploy the result.

Expected result:

Normally I would expect this to work normally and it used to.

Actual result:

Now it's not linking correctly, but the rest of the content looks good.

Details

Rather than rendering <a> links the jekyll renderer is not recognizing [...](...) and outputting it verbatim. I am suspecting since it's a table it's expecting additional spacing or something silly like that.

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question Answer
@microsoft/api-documenter 7.24.1
@microsoft/api-extractor 7.43.0
Operating system? ubuntu (github actions/pages)
Documentation target? markdown
Would you consider contributing a PR? yes
TypeScript compiler version? [email protected]
Node.js version (node -v)? 18.19.0
pnpm 9.2.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needs triage
Development

No branches or pull requests

1 participant