https://github.com/tadatuta/bem-info-source

collector tools for bem-info data
https://github.com/tadatuta/bem-info-source

Last synced: 10 days ago
JSON representation

collector tools for bem-info data

• Host: GitHub
• URL: https://github.com/tadatuta/bem-info-source
• Owner: tadatuta
• Created: 2013-08-23T14:01:12.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-08-23T14:07:21.000Z (about 11 years ago)
• Last Synced: 2024-10-23T20:55:31.322Z (22 days ago)
• Language: JavaScript
• Homepage:
• Size: 49.8 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
bem-info-source

=====

Инструмент для сборки документации для сайта bem-info.

### Установка

* Клонируем репозиторий `[email protected]:tormozz48/bem-info-source.git`

* Переходим в него `cd bem-info-source`

* Устанавливаем зависимости `npm install`

* Запускаем сборку `bem make`

### Настройка

Список ресурсов которые попадут в сборку находится в файле `.bem/sources.js`

Элмента спска ресурсов имеет вид:

```

'content/articles/bem-articles': {

    type: 'git',

    url: 'git://github.com/bem/bem-articles.git',

    treeish: 'bem-info-data',

    npmPackages: false

},

```

где:

* `type` - тип репозитория

* `url` - путь до репозитория

* `treeish` - ветка

* `npmPackages` - флаг сбора зависимостей

### Примечание

Документация и статьи вместе с соответствующей мета-информацией помещаются

в единый json файл в корне проекта ` data.json`. При этом документация wiki и md формата

преобразуется в html.

Формат вывода `data.json`:

```

{

    "en": {

        ...

    },

    "ru": {

        "bem-method-filesystem": {

            "content": "
JavaScript по БЭМ: основные понятия ...."

        },


        ...

    },

    "ja": {

        ...

    }

}

```