Let a file say it's written for reader with reader: in its front matter
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 62/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- javascript
- Domain
- frontend
Research direction
Read docs/page.md and the markdown handling referenced at static/markdown.js:61-72; check how front matter and the byline are handled. The issue leaves the version format and whether generators should write the key as open questions. Done means docs/page.md documents the key and the byline does not show it.
Written by the indexing model from the issue text.
Description
Part of #201.
Every GitHub-flavored markdown file is also reader-markdown, so a page that gets a .md file from somewhere else can't tell from its syntax whether it was written for reader.
A type: slides or type: workbook line says so (static/markdown.js:61-72), but a plain document has nothing that does.
A front matter key could say it:
---
title: Jeremiah 1–6
reader: 0.0.7
---
reader:says the file is meant to be read with reader.- Its value, if it has one, is the version of the syntax it was written for. That matters while the syntax can still change in 0.0.x: a viewer that's out of date can say so, rather than showing the page wrong.
- reader itself shows nothing for it; it isn't in the byline.
Questions
- Is a version worth having, or is
reader: trueenough until 1.0? - Should
reader-authors' generators write it?
Done when
- The key is in
docs/page.md, and the byline leaves it out.
- 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