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

Generated API docs escape Markdown #28

Open
imiric opened this issue Dec 13, 2024 · 0 comments
Open

Generated API docs escape Markdown #28

imiric opened this issue Dec 13, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@imiric
Copy link

imiric commented Dec 13, 2024

Currently the Markdown generated by npm run build:docs escapes Markdown, which causes links to not render properly.

2024-12-13-143815_961x182_scrot

See the WidgetState page, its source, and the TSDoc it's generated from.

I initially wanted to fix this directly in the friendly-docs repo, but then noticed it was copied from here.

This seems to be a known issue in api-documenter, but I'm not familiar enough with this process to propose a fix. Could it be worked around in docudocs.mjs, like we seem to be doing for column delimiters?
@imiric imiric added bug Something isn't working documentation Improvements or additions to documentation labels Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@imiric