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

[ Question ][ Playground ] Intended Behaviour? #371

Open
PhoneDroid opened this issue Dec 23, 2023 · 2 comments
Open

[ Question ][ Playground ] Intended Behaviour? #371

PhoneDroid opened this issue Dec 23, 2023 · 2 comments

Comments

@PhoneDroid
Copy link

Playing around with the Playground preview I notice that some
things break and don't render as they for example do in VSCode.

  • Code blocks ``` show an error if they are aren't exactly one space from the *

    /**
     *  ```ts
     *
     *  ```
     */

    -> The opening backtick for a code fence must appear at the start of the line

  • Markdown doesn't render properly?

    Headlines ( # Header , .. ) just aren't formatted

    image

@Gerrit0
Copy link
Contributor

Gerrit0 commented Dec 26, 2023

TSDoc does not support headings yet. #197

In general, TSDoc does not follow markdown. Most documentation tools render markdown, but because markdown isn't a format that can be trivially interpreted by a human, the TSDoc champions at Microsoft decided not to use it for TSDoc, just taking some of the same syntax.

@PhoneDroid
Copy link
Author

It's used in your own docs ..
https://tsdoc.org/pages/tags/example/#example-b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants