question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support multiple markdown files properly

See original GitHub issue

Describe the bug Storybook/addon-notes Currently the storybook/addon-notes expects one markdown file. It would be nice, if you could serve an array of markdown files. If I simply concatenate two markdown files, the first line of formatted markdown will not get rendered properly.

To Reproduce Steps to reproduce the behavior:

  1. Create markdownFileA.md. Content: Text
  2. Create markdownFileB.md, content: # headline
  3. Create a story with addon-notes:
{
        notes: {markdown: markdownFileA + markdownFileB}
}

Expected behavior The contents of both markdown files should be displayed correctly

Screenshots renderedMarkdown

System:

  • OS: Windows7
  • Browser: Chrome
  • Addons: Notes
  • Version: 5.0.11

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
shilmancommented, Sep 11, 2019

FYI addon-notes is being superceded by addon-docs, which fixes some problems with notes and is also more full-featured. It’s reached release candidate (RC) status and will be properly released soon. Please give it a try! https://medium.com/storybookjs/storybook-docspage-e185bc3622bf

1reaction
shilmancommented, Jun 10, 2019

What if you do:

notes: { markdown: `${markdownFileA}\n\n${markdownFileB}` }
Read more comments on GitHub >

github_iconTop Results From Across the Web

Markdown and including multiple files - Stack Overflow
The short answer is no. The long answer is yes. :-) Markdown was designed to allow people to write simple, readable text that...
Read more >
Multi-file Documents - Marked 2
You can include external files in a single preview document by using the syntax <<[path/file] at the beginning of a line. The line...
Read more >
Working With Multi-File Markdown Documents
A nice CLI utility for weaving together a complete document from multipl Markdown files.
Read more >
Getting Started | Markdown Guide
Create a Markdown file using a text editor or a dedicated Markdown application. · Open the Markdown file in a Markdown application. ·...
Read more >
Markdown Support | PyCharm Documentation - JetBrains
PyCharm recognizes Markdown files, provides a dedicated editor with ... a properly indented list of headers available in the current file.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found