Export a page with its source and where its asides are sent
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 55/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- javascript
- Domain
- tooling
Research direction
Start in src/export.js at exportHtml and see how it currently assembles the rendered HTML plus stylesheet, then look at the renderer used for asides (#202) since the inlined script must reuse it. Read #68 for the review-copy flow and #69 for the POST target so the new option names line up with where the export is consumed. Done means the new options are optional and today's output is unchanged, plus a test asserting a comment's text is absent while line numbering is preserved.
Written by the indexing model from the issue text.
Description
Part of #68.
Today
An exported page is the rendered HTML and its stylesheet, and nothing in it runs ("Nothing in the file draws", src/export.js). A review copy (#68) needs more than that, and so does a page served by reader-margin:
What to do
Let an export carry:
- Its source. The script draws asides from it, with the same renderer (#202), so they look as they do in reader. HTML comments are blanked line for line, so a note to whoever opens the file isn't published, and every line keeps its number.
- Which version it is. For a review copy, that's the sent copy's id (#68). For a page served from git, it's the commit it was exported from, so asides sent back can be placed against that commit and merged.
- Where its asides go. #68 downloads a file, #69 POSTs to a local reader, and reader-margin sends them to its server. The page's script is the same each time, and the export says which target it uses.
- The script itself. Inline for a review copy, with a content policy that allows only that script and no network. A served page may load the script from its server instead.
Done when
-
exportHtmltakes these as options, and an export without them is exactly what it is today. - A test checks that a comment's text isn't in the exported page and that its lines still number the same.
🤖 Generated with Claude Code
- 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 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
-
accessibility
Difficulty 3/5 1-2 days Newbie friendliness 60/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
OWASP/CheatSheetSeries#3018 ·
Maintainers usually reply within 1 day
-
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
-
Difficulty 1/5 1-3 hours Newbie friendliness 83/100
GoogleChrome/modern-web-guidance-src#3675 · 2 comments ·
Maintainers usually reply within 1 day