FLUID-5634: "*" character has been erased in workflow publishing infusion docs site from markdown

Metadata

Source
FLUID-5634
Type
Bug
Priority
Critical
Status
Closed
Resolution
Fixed
Assignee
Jonathan Hung
Reporter
Antranig Basman
Created
2015-04-19T12:58:59.062-0400
Updated
2022-03-14T12:33:57.884-0400
Versions
N/A
Fixed Versions
N/A
Component
  1. Tech. Documentation

Description

In the ChangeApplierAPI.md page, several of the code segments contain a "" character - this is still visible in the github-rendered markdown at https://github.com/fluid-project/infusion-docs/blob/master/src/documents/ChangeApplierAPI.md - e.g. "{otherComponent}.model."

However, in the published site, these characters have been destroyed - http://docs.fluidproject.org/infusion/development/ChangeApplierAPI.html

Inspecting the DOM it appears that these have undergone some further round of interpretation which has mistakenly interpreted them as directives for emphasis <em> (even though they do not pair up properly)

We need to check whatever markdown processor we are using in the publishing chain and ensure that it uses processing rules more similar to github's

Comments

  • Antranig Basman commented 2015-04-20T09:53:20.488-0400

    I was able to find a form to render this which keeps both "marked" and github happy by using the entity reference &#42; to represent the "*" character. Note that the HTML5 entity &ast; is not supported - destroyed at least by github

  • Justin Obara commented 2022-03-14T12:33:57.784-0400

    This appears to have been addressed by using the HTML entity for *