One way to write settings, and what each covers

Open
#112 0 comments 0 reactions 0 assignees View on GitHub

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

enhancement

Settings are written three ways today, each with its own scope:

  • the front matter, for the whole file (title:, font:, transition:, and now multibox: 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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jzheaux/reader

All issues in jzheaux/reader

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.