microsoft / microsoft/tsdoc

[ Question ][ Playground ] Intended Behaviour?

Open
#371 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Playground preview linked in the issue and reproduce the code-fence spacing error and the unformatted Markdown headings using the examples provided. Compare the results with VSCode, then establish whether the differences are intended and record the agreed behavior or follow-up scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.