Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown/HTML doesn't render in nested properties #5243

Open
nateKlaux opened this issue Nov 21, 2024 · 0 comments
Open

Markdown/HTML doesn't render in nested properties #5243

nateKlaux opened this issue Nov 21, 2024 · 0 comments
Labels
bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@nateKlaux
Copy link

Describe the Bug

In local development, nested property descriptions fail to render Markdown/HTML formatting. Instead, they display the raw text, e.g.:

  • [link title](link-url)

Notes:

  • This issue occurs only for nested properties (e.g., items within an array/object).
  • It doesn't render incorrectly in live documentation, but in local dev causes contributors to doubt whether their formatting is correct.

Information to Reproduce

CLI Version

"version": "0.45.0-rc52"

Actual Behavior

bug

Expected Behavior

expected

API Definition (if relevant)

                    customAddress:
                      type: [object, 'null']
                      description: > 
                        Description goes here.
                      properties:
                        addressName:
                          type: string
                          description: Description goes here.
                        description:
                          type: string
                          description: Description goes here.
                        categoryName: 
                          type: string
                          description: > 
                            **This property was deprecated in October 2024.**<br><br>The entity category given to the custom address when it was registered.
                          deprecated: true
@nateKlaux nateKlaux added the product/docs Fern Docs which builds and hosts a developer documentation site label Nov 21, 2024
@nateKlaux nateKlaux changed the title [Bug] [Bug] Markdown/HTML doesn't render in nested properties Nov 21, 2024
@dannysheridan dannysheridan changed the title [Bug] Markdown/HTML doesn't render in nested properties Markdown/HTML doesn't render in nested properties Nov 26, 2024
@dannysheridan dannysheridan added the bug Issues reporting bugs. label Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issues reporting bugs. product/docs Fern Docs which builds and hosts a developer documentation site
Development

No branches or pull requests

3 participants