lemmy-docs icon indicating copy to clipboard operation
lemmy-docs copied to clipboard

Document all markdown features.

Open vdualb opened this issue 11 months ago • 4 comments

Currently markdown documentation at https://join-lemmy.org/docs/users/02-media.html lacks information about tables and footnotes. At least that's what I could find. Including full documentation about extended markdown features is very useful for developers of client apps, because lack of such support in their apps can hurt their reputation. And it's very unfortunate, when lack of support is only because developer doesn't know about such features.

vdualb avatar Jan 27 '25 15:01 vdualb

I'm not sure markdown can do a table within a table, but you could add footnotes to that table if you like.

dessalines avatar Jan 27 '25 17:01 dessalines

I'm not sure markdown can do a table within a table, but you could add footnotes to that table if you like.

I assume tables are from gfm and spec says that cells are inlines and table itself is a leaf: https://github.github.com/gfm/.

Markdown-it-footnote references pandoc in their readme and pandoc doesn't seem to be documented as well as commonmark: https://pandoc.org/MANUAL.html#footnotes. I think footnote coment is a container and reference is inline.

vdualb avatar Jan 28 '25 04:01 vdualb

Feel free to make a pull request. The file is here:

https://github.com/LemmyNet/lemmy-docs/blob/main/src/users/02-media.md

Nutomic avatar Jan 28 '25 09:01 Nutomic

I also don't think we need an comprehensive markdown guide, that's done better elsewhere, and we even link to one. Just the basics, and the lemmy-specific additions.

dessalines avatar Jan 28 '25 18:01 dessalines

Fixed by the above PR.

dessalines avatar Jul 12 '25 03:07 dessalines

There is no info about tables

vdualb avatar Jul 12 '25 03:07 vdualb

This isn't a markdown project, we don't need to document every feature markdown has. We even link to the commonmark tutorial.

dessalines avatar Jul 12 '25 13:07 dessalines