FusionAuth / fusionauth-issues

FusionAuth issue submission project
https://fusionauth.io
90 stars 12 forks source link

Fix formatting for all inlined conditional markdown in docs #2699

Open robotdan opened 3 months ago

robotdan commented 3 months ago

Fix formatting for all inlined conditional markdown in docs

Description

During the doc migration we added a bunch of conditional markdown. This partially works, but we lose formatting and line breaks.

It would be ideal if we could figure out how to make this work as is, but otherwise we need to look for all uses of this pattern and move the inlined markdown to includes.

Example of bad usage

  {!props.create_user && <>
  <APIField name="user.memberships" type="Array">
    The list of memberships for the User.

    This is a line break and we should expect the rendered output to have a line break with space and then this text. 
  </APIField>
 </> }

Example fix

All inlined code is moved to a separate .mdx file and then included like this:

  {!props.create_user &&
    <UserMembershipFieldsResponse />
  }

Community guidelines

All issues filed in this repository must abide by the FusionAuth community guidelines.