ReactDoc — первое open source решение программы «Единая фронтальная система»

[Luanre]

Было, однако, React ввел хайп на тему компонентов, раньше эта тема никогда так бурно не обсуждалась

[raveclassic]

Демку бы залили куда-нибудь.

[Luanre]

Пример пока можно посмотреть в папке examples
https://github.com/Sberbank-Technology/ufs-react-doc/tree/release/1.0/examples/simple
Планируем добавить на gh-pages

[vintage]

Напишите, когда добавите. Интересно чем отличается от всяких tsdoc.

[Luanre]

Генератор сам по себе основан на typedoc, для себя внутри команды мы начали генерировать документацию изначально с помощью него. Конечно, мы еще не все фишки генератора перетащили на гитхаб, но мы работаем над этим и скоро проект пополнится новыми фишками :)
Если интересно, можете оставить контакты на [e-mail] и будем держать в курсе событий

[timramone]

Так и где там пример? Там пара компонентов и всё. Как мне понять, что делает ваш генератор документации, не запуская npm run docs-dev самостоятельно? :)

[Luanre]

Временно разместил пример здесь

Код, по которому был сгенерирован пример

declare var require: any;

import * as React from 'react';
const styles = require('./Button.css') as any;

export enum ButtonType {
    Small, Standard, Big
}

interface Props {
    /** onClick handler */
    onClick?: React.EventHandler<React.MouseEvent<HTMLButtonElement>>;

    /** Button type */
    type?: ButtonType;
}

/** 
 * Simple button
 */
export default class Button extends React.Component<Props, {}> {
    onClick = (event) => this.props.onClick(event);

    render() {
        let className;
        const { type } = this.props;

        switch(type) {
            case ButtonType.Small:
                className = styles.small;
                break;
            case ButtonType.Big:
                className = styles.big;
                break;
            case ButtonType.Standard:
            default:
                className = styles.standard;
        }

        return <button className={className}>{this.props.children}</button>;
    }
}

[Opty]

Вот в ридми это надо первым делом, а то вообще непонятно с ходу — что делает. А так молодцы, лайк!)

[timramone]

Спасибо, стало на много лучше.

[Chaptykov]

Да, очень бы хотелось скриншот, демо, сравнение с конкурентами (например, Styleguidist или SourceJS).

[olegshilov]

styleguidist на три головы выше
то что увидел в примере это просто вывод пропсов в таблицу на бустрапе.