One way to write settings, and what each covers
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Active
- Tech stack
- javascript, markdown
Research direction
Start by reading the settings examples in the issue: front matter, slide note comments, and name:[] widgets. Then trace how the reader currently parses and applies each form, including the linked include issue #71. Done means choosing a syntax and inheritance rules for files, sections, slides, included files, and templates, and deciding which settings remain controls.
Written by the indexing model from the issue text.
Description
Settings are written three ways today, each with its own scope:
- the front matter, for the whole file (
title:,font:,transition:, and nowmultibox:stages:); - a comment block in a slide's notes, for that slide (
background:,transition:); name:[]widgets, for the heading they're under and its subheadings (multiplier:[],reset:[]).
One syntax for configuration, wherever it's written, with one rule for what it covers: a file, a section, a slide, a file another includes (#71), a template. With that settled, a setting that today can only be set file-wide (such as staged-box stage names) could also be set for a section, so two kinds of staged list could live in one file.
To decide:
- Where a section's or slide's settings are written, and in what syntax (front-matter-like YAML in a block, the notes' comment, …).
- How settings are inherited: file → section → subsection; deck → slide; an including file → the included one.
- Whether
name:[]stays only for things that put a control on the page (it should; a setting isn't a control).
- 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
-
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