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.