[ Question ][ Playground ] Intended Behaviour?

[PhoneDroid]

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 ``</code> 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

  

[Gerrit0]

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]

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