A reader-markdown file should open as reader shows it, from any site
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- javascript
Research direction
Start with sub-issues #202–205, which break the work into browser rendering, front matter, a hosted viewer, and an extension. Read the renderer and browser build-step work in #202 first; the issue names no files or tests. Done means reader-markdown files can be rendered from a URL or browser tab, with answers saved locally and downloadable via “Save my copy.”
Written by the indexing model from the issue text.
Description
Someone who browses to https://some.site/lesson.md sees plain text. If the file was written for reader, they should see it as reader shows it: a document with its masthead and asides, a workbook they can fill in, or a deck they can present. This should work without installing reader, as 0.0.7 promises.
How
The renderer can run in a browser with a build step, so the page that's served and the app render the same way. On that:
- A hosted viewer on the docs site takes a file's URL and shows it. It needs no install, and works for any host that shares its files with other sites, as GitHub does.
- A browser extension recognizes a reader file opened in a tab, from any host, and shows it in place.
What's filled in can't be written back to a file someone else serves. Instead it's kept in the browser, and Save my copy downloads the file with the answers in it, ready to open in reader.
A file needs a way to say it's meant for reader, since every markdown file is also reader-markdown: a reader: front matter key.
Sub-issues
- #202 Render in a browser from the same renderer, with a build step
- #203 Let a file say it's written for reader with reader: in its front matter
- #204 Show a reader file from its URL on the docs site, with no install (needs #202)
- #205 Show a reader file opened in a browser tab with an extension (needs #202, #203; last)
- 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