tuchk4/storybook-readme

Relative paths in readme files.

Open

#78 建立於 2018年7月6日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)JavaScript (541 star) (259 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.