racket / racket/racket

Suggestion of parameters in margin-note (in Scribble) and behavior with #:left? #t. Thank you.

Open
#3,129 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation feature request
Dominant language
Racket
Stars
5.2k
Forks
698
Avg merge
18h 34m
Merged PRs (30d)
5

Description

Adding the following parameters to margin-note and margin-note* {#:frame? , #:background-color?} (or similar names) would be very helpful to display the embeddings of youtube and Google Forms (that the new scribble-embedding package makes possible,) inside a Scribble generated document (for the case of HTML) .

Concerning the behavior of margin-note and margin-note* using the parameter #:left? set to true, please verify that the content do not justify to the left as expected, but goes further left than necessary. Thank you for this very useful option to organize our information under Scribble.

Thank you all for the great work on Scribble and beyond.
Please Keep Safe.

Contributor guide

Open the contributing guide

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.

Research direction

Start by locating Scribble's margin-note and margin-note* definitions and the HTML-generation path. Check how #:frame?, #:background-color?, and #:left? are currently handled, then use focused Scribble examples or tests to verify embedded content and left alignment. Done means the requested parameters work for HTML output and left-aligned notes no longer extend farther left than intended.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.