https://github.com/hstsethi/structured-list-md
Guidelines, scripts for authoring structured, machine readable lists in plain Markdown by leveraging HTML.
https://github.com/hstsethi/structured-list-md
html html5 json list machine-readable markdown markup open-format spec specification structured-data
Last synced: 3 months ago
JSON representation
Guidelines, scripts for authoring structured, machine readable lists in plain Markdown by leveraging HTML.
- Host: GitHub
- URL: https://github.com/hstsethi/structured-list-md
- Owner: hstsethi
- Created: 2025-01-02T12:46:09.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-20T04:59:20.000Z (4 months ago)
- Last Synced: 2025-01-20T05:21:48.436Z (4 months ago)
- Topics: html, html5, json, list, machine-readable, markdown, markup, open-format, spec, specification, structured-data
- Language: Shell
- Homepage:
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# structured-list-md
Guidelines, scripts for authoring structured, machine readable lists in plain Markdown by leveraging HTML.
## Guidelines
- The input must be valid markdown.
- The list can be either ordered(numbered) or unordered(bulleted).
- Description is not necessary, but if it's there, it should be preceded and followed by a new line.
- There should not be any newline between items that do not have descriptions, else the markdown parsers will introduce additional `p` tag after `li`.
## Conversions
- li -> dt
- p -> dd
- ul/ol -> dl
## Input Markdown Item List
```md
- Item 1
Description of item 1.
- Item 2
- Item 3
```
## Intermediate HTML Item List
```html
- Item 1
Description of item 1.
- Item 2
- Item 3
```
## Final HTML Definition List
```html
- Item 1
- Item 2
- Item 3
```