styleguidist/react-styleguidist

Documenting design systems: Support for tabs in component pages / more examples for layouts

Open

#1,170 创建于 2018年10月11日

在 GitHub 查看
 (9 评论) (3 反应) (0 负责人)TypeScript (1,416 fork)github user discovery
documentationhelp wanted

仓库指标

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

描述

The problem

When using styleguidist for design system docs, not just as a component library, there is a lot of additional content that one want's to add to styleguidist. See article from Nathan Curtis here: https://medium.com/eightshapes-llc/documenting-components-9fe59b80c015 Styleguidist default templates are a bit tuned towards documenting component api and code examples. Eg. having props and methods first

In general I'd like to see a few more examples of themes for document page and for sidenav too. E.g. how to arrange stuff to tabs / paragraphs and prioritize.

I'm not sure if this needs actual new features, or just more examples.

贡献者指南