markdown-completeness
- Dominant language
- JavaScript
- Stars
- 500
- Forks
- 125
- PR merge metrics
- No merged PRs in 30d
Description
I want jeztz to be able to succinctly and intuitively display the following types of text:
1. emphasis
2. strong type
3. strikethrough
4. sub/super-script
5. block quotes
6. ordered and unordered lists
7. headings
8. hyperlinks
1-4 are simple and obvious.
5 could be done by some combination of the following:
- weak type
- emphasis
- double-quote wrapping as currently done for inline quotes
- inserting some kind of 'begin-quote', 'end-quote' tokens with appropriate pauses to ease the mental shift.
I think 6 could be done nicely by putting the bullets/numbers in the left wrap section.
7 is tricky because there are different levels of heading. Even if there weren't, choosing a way to represent a heading is not obvious. Possible options are:
- Making the text bigger (I strongly dislike this idea)
- Making the words ALL CAPS (I only vaguely dislike this idea)
- Using some kind of wrapper (as is currently done for parens and double quotes)
Of course whatever is done would have to be accompanied by appropriate pausing.
I think I have a decent solution for 8:
- Render link text blue, with a link icon in the left wrapper, and a good long pause.
- Put an unobtrusive list of links above or below the reader which gets populated as and when links are seen in the text, so the user can click them (or press a key to pause the reader and open the most recently seen link in a new tab)
As far as I'm concerned, code blocks, images, tables, etc, make no sense for jetzt. However, it might be nice to deal with them in a similar way to hyperlinks.
Thoughts?
Contributor guide
Research direction
Start by reviewing the existing inline-quote rendering mentioned in the issue and locating how Markdown text is currently parsed and displayed. Define which elements are in scope first, then specify their speech, pause, wrapping, and link behavior so completion can be tested consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100