Skip to content

Document all markdown features. #344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RocketRide9 opened this issue Jan 27, 2025 · 4 comments
Open

Document all markdown features. #344

RocketRide9 opened this issue Jan 27, 2025 · 4 comments

Comments

@RocketRide9
Copy link

RocketRide9 commented Jan 27, 2025

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.

@dessalines
Copy link
Member

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

@RocketRide9
Copy link
Author

RocketRide9 commented Jan 28, 2025

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.

@Nutomic
Copy link
Member

Nutomic commented Jan 28, 2025

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

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

@dessalines
Copy link
Member

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.

discomrade added a commit to discomrade/lemmy-docs that referenced this issue Mar 28, 2025
discomrade added a commit to discomrade/lemmy-docs that referenced this issue Mar 28, 2025
dessalines added a commit that referenced this issue Apr 7, 2025
* Add footnote formatting example

Addresses part of #344

* Running prettier.

---------

Co-authored-by: Dessalines <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants