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 (259 forks)batch import
feature requesthelp wanted

Repository metrics

Stars
 (541 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Investigate how storybook readme fetches and renders READMEs, and look for ways to resolve relative URLs. Consider adding a base URL option or transforming relative paths to absolute ones using the GitHub raw URL.
Tech stack
javascriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsStorybook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75