styleguidist/react-styleguidist

Improve single-component usage

Open

#195 创建于 2016年10月12日

在 GitHub 查看
 (16 评论) (5 反应) (0 负责人)TypeScript (1,416 fork)github user discovery
enhancementgood first issuehelp wanted

仓库指标

Star
 (11,091 star)
PR 合并指标
 (PR 指标待抓取)

描述

React Styleguidist could be awesome for documenting components, like this, but now it’s not.

  • New option to disable sidebar.
  • New option, getComponentName(), to change the title. @visibleName JSDoc tag — #933
  • “Fork me” ribbon with customisable URL.
  • New option to hide isolated link (needs discussion).
  • Hide path line if it’s empty.

Anything else? Any feedback?

贡献者指南

研究方向
查看问题评论中的讨论，了解所需的新选项（例如，禁用侧边栏、隐藏独立链接）。检查styleguidist源代码以了解现有选项的实现方式，并提出添加新配置选项并提供适当文档。
技术栈
reactjavascripttypescript
领域
frontenddeveloper experience
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
ReactJavaScript
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65