Definition lists support

ferk6a commented 5 years ago

Feature description

I would like support for description lists like in Kramdown, PHP Markdown Extra, Pandoc and MultiMarkdown. Here's how they usually look:

Apple
:   Pomaceous fruit of plants of the genus Malus in 
    the family Rosaceae.
:   An American computer company.

Term 1
Term 2
:   Definition a

Term 3

:   Paragraph 1
    Continuation of paragraph 1

:   Paragraph 2

Feature motivation

My approach to note-taking heavily involves definition lists. I believe they are a very useful tool to define words in general, think of it as unordered lists but with an indexed key like a dictionary. The important thing here is that they bring indentation without having circles, numbers and irrelevant stuff on the way, it's just nicer to read.

Examples of my usage:

# Movement
C-a, C-e
: start, end of the line

M-f, M-b
: forward, backward word

# Improvements and complements over existing tools
[`visidata`](http://visidata.org/)
: interactive multitool for tabular data
: brings
  * clarity of a spreadsheet
  * efficiency of a terminal
  * power of Python
: Python

Feature example

Here is how it renders in my current "note-taking model" (a simple markdown -> html converter using markdown-it-deflist):

I believe I could take on this issue, once I figure out the code base. I have tried to make my own note-taking solution, but I didn't bother to make an actual application for it, just a compiler using already-made tools, so I'm looking forward to this project!

fabiospampinato commented 5 years ago

Strange syntax, I've never heard of that before. Let's see how many people find this useful, but IMHO this should be implemented as a plugin #128.

fabiospampinato commented 4 years ago

Reference: https://www.npmjs.com/package/markdown-it-deflist

notable / notable