[Addon: Notes] - V5 - Weird formatting occurs when using markdown code snippet (```code```)
See original GitHub issueDescribe the bug When using markdown with the notes addon, in version 5.x, special characters are showing abnormal spacing.
To Reproduce Steps to reproduce the behavior:
- Follow the directions to add notes to the storybook project
- add a markdown file or include markdown in your ts file (This markdown should include code snippets using tacs 3 tacs(`) code and then another 3 tacs(`)
- in the configuration, add - notes: someMarkdownHere
- run storybook and look to the notes section
Expected behavior I should be able to go to the notes section and see a correctly formatted code snippet
Screenshots
What is currently being shown:
What should be shown:
Code snippets
See markdown below (remove slashes next to ticks):
# Component name
Component description
## Installation
directions:
/`/`/`
npm install --save libaryname
/`/`/`
## Usage
html snippet
/`/`/`
<component-a
[x]="x value goes here"
[y]="y value goes here"
[z]="z value goes here"
</component-a>
/`/`/`
System:
- Browser: [chrome, firefox (havee not checked ie)]
- Framework: [Angular (but may not be specific to Angular)]
- Addons: [addon-notes, addon-knobs, addon-a11y, addon-viewport, addon-actions]
- Version: [5.0.0-beta.3]
Additional context I have run the markdown files through several MD checkers and they are valid so I think I have ruled out user error on this one.
Issue Analytics
- State:
- Created 5 years ago
- Comments:12 (11 by maintainers)
Top Results From Across the Web
Extended Syntax - Markdown Guide
Several individuals and organizations took it upon themselves to extend the basic syntax by adding additional elements like tables, code blocks, syntax ......
Read more >Prism
PrismJS Tutorial | Implement Prism in HTML and React; Code syntax highlighting in Pug with :highlight and :markdown filters using pug-loader and Prism.js....
Read more >Pandoc User's Guide
Pandoc is a Haskell library for converting from one markup format to another, and a command-line tool that uses this library. Pandoc can...
Read more >Posting Code Blocks on a WordPress Site - CSS-Tricks
To post a block of code in Markdown, one ways is to indent that code four spaces on ... I prefer using a...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I’ll pick this up
@CodeByAlex I think the area we render the code in changed? I’m not really sure TBH, I am just trying to triage it at this point 😃