Яндекс

Владимир Гриненко, Яндекс

Яндекс

Автоматическая генерация актуальной документации для модульного фронтенда

Субботник

Владимир Гриненко,
руководитель группы общих компонентов

Документация — это хорошо

Автогенерируемая документация — лучше!

Что есть

Что было

Что еще было

Что еще было

Что появилось

bem-lib-site

Как устроено

Как устроено

bem-lib-site-data

bem-lib-site-data

bem-lib-site-data

bem-lib-site-data

Структура данных

library
    version
        gh: '',
        readme: '',
        changelog: ''
        migration: ''
        sets
            desktop
                button
                    docs: ''
                    jsdoc: ''
                    examples: ''
                    sources: ''

bem-lib-site-view

Как использовать

Как использовать

npm i bem-lib-site

Как использовать

npm i bem-lib-site
bem-lib-site path/to/my/lib

Как использовать

blocks/
    button/
        button.js
        button.bemhtml.js
    input/
    ...

Как использовать

blocks/
    button/
        button.md
        button.js
        button.bemhtml.js
    input/
    ...

button.md

bem.info

Конфигурация

'bem-lib-site-data': {
    tempFolder: 'tmp',
    outputFolder: 'output',
    platforms: { desktop: ['common', 'deskpad', 'desktop'] },
    libs: {
        'bem-components': {
            langs: ['ru', 'en'],
            github: {
                url: 'github.com', user: 'bem', repo: 'bem-components', defaultBranch: 'v3'
            }
        }
    }
}

Планы на будущее

Ваши вопросы!

Контакты

Владимир Гриненко

руководитель группы общих компонентов

bem.info

info@bem.info