speced / speced/respec

HTML gets ignored in markdown specs

Open
#2,850 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

Important info

Description of problem

What happened: HTML sections like abstract, conformance etc. are no longer recognized. The spec is using format: "markdown", where the main file is HTML, but it includes some markdown files (seen here).

But what I was expecting?: The documentation says, "When format is set to "markdown", you can use a mix of HTML and markdown" (see here). This worked before, but not anymore.

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 with the affected draft/index.html and the linked ReSpec format documentation, using ReSpec 25.6.2 to reproduce the mixed HTML and Markdown case. Trace the format="markdown" processing entry point and compare how HTML sections such as abstract and conformance are recognized; done means those sections are recognized again when HTML and Markdown are mixed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.