storybook-readme icon indicating copy to clipboard operation
storybook-readme copied to clipboard

Relative paths in readme files.

Open dylanaubrey opened this issue 6 years ago • 4 comments

We are using storybook-readme to display each component's github readme within storybook... some of the readmes have links with relative paths to other github pages and these links are broken when the readme is rendered in storybook.

I wanted to find out if there is a recommended way of dealing with this?... and if not, whether there are any plans to support this? Cheers.

dylanaubrey avatar Jul 06 '18 12:07 dylanaubrey

I think is is possible to replace relative links with absolute link (baseUrl + relative link).

The problem is -- how to set baseUrl?

I would be happy for any help with this issue.

This feature could be implement at services/marked.js. (service that transforms raw markdown to html with marked.js).

Here is baseUrl option at its docs - prefix url for any relative link. The only issue - find way how setup baseUrl at storybook and pass it to marked.

tuchk4 avatar Aug 15 '18 09:08 tuchk4

I'm having problem with this as well. I wan't to add an image with relative URL to my README.md file but it does not work.

![Button example](../../../static/button_example.jpg)

Is there any plans for solving this?

B3Kay avatar Mar 27 '19 14:03 B3Kay

same problem here how I can display an image in the readme?

daniele-zurico avatar Jun 03 '19 15:06 daniele-zurico

Same problem here. Is this plugin issue or is it the Storybook issue?

Galiant avatar Dec 12 '19 15:12 Galiant