Skip to content

feat(migration): support reference numbers in code blocks #404

Description

@dwmkerr

Summary

The book manuscript uses numbered reference annotations in code blocks to explain specific parts of commands or output. For example, in the "pushing and popping the working directory" section, numbers appear inline in the code that correspond to explanations below.

Example

The book format shows something like:

$ pushd ~/effective-shell  ①
~/effective-shell ~
$ pushd /var/logs          ②
/var/logs ~/effective-shell ~

① Explanation for the first command
② Explanation for the second command

Current Limitation

Our markdown/MDX code blocks don't support inline reference numbers with corresponding annotations.

Proposed Solution

Investigate options for supporting this pattern:

  • Custom MDX component for annotated code blocks
  • Docusaurus plugin or extension
  • Alternative styling approach

Image

Affected Pages

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions