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

Bullet-point lists are escaped when producing the md file #35

Open
rgosse opened this issue Nov 29, 2021 · 2 comments
Open

Bullet-point lists are escaped when producing the md file #35

rgosse opened this issue Nov 29, 2021 · 2 comments
Labels
bug Something isn't working 🐎 priority

Comments

@rgosse
Copy link
Collaborator

rgosse commented Nov 29, 2021

A list with hyphens has its new line characters removed:

- list
- of
- things

becomes

-list - of -things

Using the * character does not work either as it will be escaped when creating the md file.

@Nouzbe
Copy link
Collaborator

Nouzbe commented Nov 30, 2021

@rgosse I think you discovered that this is not as easily fixable as it seems. Can you add some details about your discovery here?

@rgosse
Copy link
Collaborator Author

rgosse commented Dec 7, 2021

Yes, api-extractor will strip new lines unless they are doubled, but doubled new lines will generate a DocParagraph which will make the bullet list appear too big.
Dylan had opened an issue about that to them some time ago:
microsoft/rushstack#1441

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working 🐎 priority
Projects
None yet
Development

No branches or pull requests

3 participants