speced / speced/respec

Allow auto-coding of <dfn>`thing`<dfn>

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

Nobody has claimed this yet.

Feature request High priority
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

Is your feature request related to a problem? Please describe.
"I'm always frustrated when [...]" I need to write:

<code><dfn>thing<dfn></code>

Describe the solution you'd like

I'd like to:

<dfn>`thing`</dfn>

And then have ReSpec automatically put code on [=thing=], so if the dfn's only child is code, then the [=thing=] should automatically be "code" too.

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 tracing ReSpec's existing dfn handling and automatic coding behavior. Test the requested thing syntax in a minimal technical document, then verify that the generated [=thing=] reference receives code formatting when the dfn's only child is code.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.