Badges under the title for a document's source, audio, video and PDF
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- javascript, markdown
- Domain
- frontend
Research direction
Start with src/columns.js at masthead, UNSHOWN, and docs/page.md under “The masthead”; trace how page images resolve paths and how titles are rendered in pages, print exports, and decks. Add the four metadata badges in the specified order, with linked addresses and readable print output, then verify all four keys are omitted from the byline and appear only under the first slide title in a deck. The issue leaves whether audio and video should play inline and whether more keys belong open, so settle that scope before implementation.
Written by the indexing model from the issue text.
Description
A document made from something else often points back to it: the page it was converted from, a recording of it, a PDF of it. Today those go in the front matter as any other key, and masthead shows each in the byline as key: value, the address written out in full and not a link:
---
title: “Before I Formed Thee in the Belly I Knew Thee”
date: October 19–25, 2026
source: https://www.churchofjesuschrist.org/study/manual/come-follow-me-for-home-and-church-old-testament-2026/43?lang=eng
audio: https://assets.churchofjesuschrist.org/ey6mryaore1dge13ql50yu2rxp2gf8hhk7wnldix-128k-en.mp3
pdf: https://assets.churchofjesuschrist.org/1u/x7/1ux7z9v262sp7s0adjqsn1fik9lpujq86bzd0s2j/october_1925_before_i_formed_thee_in_the_belly_i_knew_thee_jeremiah_13_7_1618_20.pdf
---
That's a lesson from Come, Follow Me converted to reader-markdown to study from; the byline is three long addresses that can't be clicked.
Let's have reader read these keys itself, and show each as a badge in a row under the title, linked to its address:
| Key | Badge | What it is |
|---|---|---|
source: |
🔗 Source | the page the document was made from |
audio: |
🎧 Audio | a recording of it |
video: |
▶ Video | a video of it, as for a talk transcribed from its recording |
pdf: |
a PDF of it |
- A badge opens its address in a tab of its own, as a link in the page does; its address shows on hover.
- They come in the order above, whatever order the front matter has them in, so documents made the same way look the same.
- A value that isn't an address, or is a path from the note (
audio: talk.mp3), is a link too, resolved as an image's is. - The keys join
UNSHOWN, so they aren't in the byline as well, anddocs/page.mdlists them under The masthead. - On paper and in an exported file, a badge still says what it is, and its address should be there to read, since nothing can be clicked on paper.
- In a deck, they sit under the title on the first slide only, if anywhere.
Open questions:
- Should
audio:andvideo:play in the page, in a small player under the title, rather than only link out? A player would let someone listen while reading and writing asides, without leaving reader. - Are there others worth having alongside, such as
slides:for a talk's deck?
To check, open a document with all four keys in its front matter: four badges sit under the title, in the order above, each opening its address, and none of the keys is in the byline.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 1
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 26
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from jzheaux/reader
-
polish
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
accessibility bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 55/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
polish
Difficulty 3/5 1-2 days Newbie friendliness 64/100
Maintainers usually reply within 1 day
Similar issues
-
Radix number block generates NaN after switching a negative or decimal number to binary, octal or hexPossibly taken @matthewalberto claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
mit-cml/appinventor-sources#4246 · 1 comment ·
Maintainers usually reply within 1 day
-
marketing
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
accessibility good first issue languages
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 2 days
-
bug help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100