ember-learn / ember-learn/guidemaker-ember-template

Research the ability to add footnote capabilities so we can add footnotes to the guides-source

Open
#14 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
5
Forks
23
Avg merge
3m
Merged PRs (30d)
3

Description

This issue is a placeholder for some research that is required to look into adding footnotes. This is not purely a technical issue, we need to investigate the effect on writing style if we were to add this functionality. We also need to be mindful of the portability of the Markdown if we're using a custom extension that isn't available in all flavours of markdown.

### Useful links
Showdown extensions currently defined: https://github.com/ember-learn/guidemaker-ember-template/blob/2032bad25c8c4e7429721a1371307ab0896ad55b/app/templates/components/guides-article.hbs#L19
potential footnote extension: https://github.com/Kriegslustig/showdown-footnotes

### Architectural notes
It's probably not sensible that the showdown extensions are actually defined or used in any way from the template 🤔 it is probably worth investigating a way to make this a guidemaker concern before adding to the existing extensions. Some examples might be to have a custom component in guidemaker that deals with markdown rendering (and setups all the correct addons)

Contributor guide

Open the contributing guide

Research direction

Start with app/templates/components/guides-article.hbs and review the Showdown extensions linked in the issue. Investigate the potential footnote extension, Markdown portability, writing-style implications, and how Markdown rendering could become a Guidemaker concern. Done means documenting the trade-offs and a recommended integration approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, markdown
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.