documentationjs / documentationjs/documentation

First item in markdown list formatted incorrectly

Open
#676 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

The first time in a markdown list isn't part of the list.

```
@param {String} foo:

- item 1
- item 2
```

translates to

```
`foo` **[String]** - item 1
- item 2
```

Real world example is the Markdown list at https://github.com/mapbox/mapbox-gl-geocoder/blob/master/lib/index.js#L198 which documentation translates this to https://github.com/mapbox/mapbox-gl-geocoder/blob/master/API.md#on.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.