Fix URLs in fenced code blocks being double-parsed
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 18/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation, tooling
Research direction
Start by reproducing the escaped characters in URLs inside fenced code blocks, especially Vuepress-style ::: code components. Compare the Craft source formatting with the automation using yiisoft/yii2-apidoc and Vuepress, then determine which layer should prevent double parsing; done means the rendered documentation preserves those URLs correctly.
Written by the indexing model from the issue text.
Description
In #464, @leevigraham pointed out that there were some < and > characters sneaking into output—but in way that suggests docblocks are getting parsed "too early" and ignoring fenced code blocks?
This may only be an issue when using the Vuepress-stlyle ::: code components.
No matter, we need to sort out whether this is something we can address with careful formatting in the Craft source, or if there is a solve at the automation level, i.e. with our use of yiisoft/yii2-apidoc (or Vuepress itself).
- Dominant language
- JavaScript
- Stars
- 42
- Forks
- 160
- Avg merge
- 3h 9m
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from craftcms/docs
-
Broken Link OpenBroken Link
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
-
Broken Link OpenBroken Link
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
[Broken Link]: Open
Difficulty 1/5 Under an hour Newbie friendliness 65/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area-deployment area-integrations triage:bot-seen
Difficulty 2/5 Half a day Newbie friendliness 86/100
-
Issue-Bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
sugarlabs/musicblocks#8924 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
ArduPilot/ardupilot_wiki#8088 ·
-
[BUG] createTool tools cannot be registered with Mastra when exactOptionalPropertyTypes is enabled Opencustomer-eng status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100