tuchk4/storybook-readme

Relative paths in readme files.

Open

#78 opened on 2018年7月6日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)JavaScript (541 stars) (259 forks)batch import
feature requesthelp wanted

説明

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.

コントリビューターガイド

技術スタック
storybookreactjavascript
領域
frontenddocumentation
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
needs investigation
前提条件
JavaScriptReactStorybook addon basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
35
調査方針
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.
Relative paths in readme files. · tuchk4/storybook-readme#78 | Good First Issue