Skip to content
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

Markdown footnotes #124

Open
ant-tar opened this issue Apr 11, 2021 · 2 comments
Open

Markdown footnotes #124

ant-tar opened this issue Apr 11, 2021 · 2 comments

Comments

@ant-tar
Copy link

ant-tar commented Apr 11, 2021

Summary

https://www.markdownguide.org/extended-syntax/#footnotes
Does docs.modx.com support footnotes? As for me it doesn't ((

Why?

I keep thinking about how best to refer to terms from glossary... Capitalizing "Snippets", "Chunks" and so on - it doesn't look cool, besides, it is not welcomed by the rules of writing MODX documentation .. but this is not the main thing. How to make a link to a term so that the user, having met him for the first time, could go and get acquainted. "See more" block and excessive use of links (for example, a new term will be encountered by the user several times in the article, should we make them clickable each time?) doesn't seem like a good idea. A footnote could help here. You can select a new term, and somewhere below (for example, under "See More") add a new section (something like "Glossary"), where you specify:

blablabla.. Snippet[1], also Chunk[2]

Glossary (or mini glossary)

[1] "Snippet" (link to Glossary, or even some portion of text...optionally with link "read more")
[2] "Chunk" (link or text..)

Wondering how to do that better, enjoy :)

@Mark-H
Copy link
Collaborator

Mark-H commented Apr 11, 2021

There is a footnote extensions for our parser that could be added, but we're not going to need that for every single reference to a "snippet" or "chunk" are we? That's gonna be a lot of footnotes! ;)

If it's needed to remind people what a chunk is on any given page, I'd suggest just using a regular link to the dedicated snippet/chunk page (not the glossary) from the first time a concept is mentioned on a page.

@Mark-H
Copy link
Collaborator

Mark-H commented Nov 23, 2022

Tried adding it but am having some trouble with getting it to work. Links don't seem to match up which may be due to using an older version but I'm not 100% sure what version is safe to upgrade to right now. Will revisit later.

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

2 participants