tuchk4/storybook-readme

Relative paths in readme files.

Open

#78 opened on Jul 6, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (541 stars) (259 forks)batch import
feature requesthelp wanted

Description

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.

Contributor guide

Tech stack
storybookreactjavascript
Domain
frontenddocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
JavaScriptReactStorybook addon basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate how storybook readme renders README files, focusing on how relative paths are handled. Look at the component that displays the markdown content, likely in the addon's source code. Consider implementing a base URL option or rewriting relative links to absolute ones based on the repository's raw content URL. Check the comments for any prior discussion or suggested approaches.