callstack/component-docs

Name: component-docs

Owner: Callstack

Description: ? Simple documentation for your React components

Created: 2016-12-04 10:34:26.0

Updated: 2018-05-12 15:29:21.0

Pushed: 2018-05-12 15:33:26.0

Homepage: null

Size: 545

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

component-docs

? Simple documentation for your React components.

Goals

• Simple API with zero-configuration
• Fully static, deployable on GitHub pages
• Both server + client routing
• Optimized for mobile screens
• Improved DX with useful features like hot reload

Non-Goals

• Customizability - it's easy enough to use react-docgen directly, though we need some simple customization features

Installation

install --save-dev component-docs

API

Currently there's no CLI available. You can use the API to generate documentation programmatically.

rt path from 'path';
rt { build } from 'component-docs';

t pages = [
type: 'markdown', file: '../docs/Get Started.md' },
type: 'component', file: '../src/Button.js', }
type: 'component', file: '../src/Calendar.js' },


d({
ges: pages.map(page => ({ ...page, file: path.join(__dirname, page.file) })),
tput: path.join(__dirname, 'pages'),

You can also use the server while actively working on documentation. Just replace build with serve in the above example.

Example

component-docs is used for react-native-paper