styleguidist/react-styleguidist

Generate Documentation in JS / TS

Open

#621 opened on Oct 4, 2017

View on GitHub
 (14 comments) (4 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wantedrequest for comments

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there anyway to declare documentation for components in JS (or TS) rather than markdown?

Having free-text (md) feels quite chaotic - writing the documentation in JS would enable us to do linting, import & share stub data, testing and have typesafety in TS.

Contributor guide

Research direction
Investigate how react styleguidist currently parses markdown documentation and propose a way to support JS/TS documentation files, perhaps by extending the config and adding a custom resolver.
Tech stack
javascripttypescriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptTypeScriptReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65