Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Markdown lists.

See original GitHub issue

It would be useful to be able to include lists in doc comments:

/**
 * This module does:
 *
 * - A thing.
 * - Another thing.
 * - One more thing.
 */

Issue Analytics

State:
Created 4 years ago
Reactions:11
Comments:7 (2 by maintainers)

Top GitHub Comments

2reactions

rbucktoncommented, Dec 17, 2019

From the linked issue, it seems the current behavior to trim insignificant whitespace is the culprit. The problem, as I see it, is that TSDoc’s parser is making assumptions about what kind of whitespace is significant that is inconsistent with what Markdown considers to be insignificant whitespace.

0reactions

octogonzcommented, Dec 17, 2019

@rbuckton The word-wrapping is tracked by issue #200.

Top Results From Across the Web

Basic Syntax - Markdown Guide

To create an ordered list, add line items with numbers followed by periods. The numbers don't have to be in numerical order, but...

Markdown Syntax Documentation - Daring Fireball

Markdown lists look like, well, lists. ... Markdown's email-style blockquoting and multi-paragraph list items work best — and look better — when you...

Basic writing and formatting syntax - GitHub Docs

Lists. Task lists. Mentioning people and teams ... You can also create a Markdown hyperlink by highlighting the text and using the keyboard...

Learn Markdown lists - Ordered, unordered examples

markdown List html tag ... In Html pages, a list of similar items represents in a formatted way for readability, Markdown also uses...

Lists - Markdown Tutorial - CommonMark

Lists · Use any of * , + or - to make a list. Each list must consistently use the same character. A...