makeup

1.0.1 • Public • Published

Build Status Gitter

Экспресс-версию Makeup можно загрузить почти на любой сайт (кроме тех, где выставлен HTTP заголовок content-security-policy). Для этого скопируйте и выполните строчку кода в консоли Dev Tools вашего браузера:

var s=document.createElement('script');s.src ="//2gis.github.io/makeup/autoload/script.js";document.body.appendChild(s)

Демо-сайт

Промо-сайт

Makeup

Makeup – инструмент для вёрстки и приятного контроля за качеством вёрстки на веб-проектах.

Вы поладите с Makeup, если ваша верстка основана на независимых блоках, а вам важна стабильность и надежность проекта.

Описание

Если говорить формально, Makeup – это js-библиотека, которая предоставляет визуальный интерфейс для изолированной разработки и быстрого ручного регрессионого тестирования вёрстки, основанной на абсолютно-независимых блоках.

Makeup предназначен

  • Для сравнения вёрстки блоков с исходными дизайн-макетами.
  • Для контроля за состояниями блоков (модификации блоков, разный контент).
  • Для комфортной изолированной разработки блоков.

Быстрый старт

Создайте страницу со всеми ресурсами вашей вёрстки (разметка, стили, изображения):

<!DOCTYPE html>
<html lang="en">
<head>
    <title>Makeup</title>
    <link rel="stylesheet" href="style.css"> <!-- Стили проекта -->
</head>
<body>
    <button class="button">My button</button> <!-- Разметка -->
</body>
</html>

Подключите два файла: скрипт и стили Makeup.

<!DOCTYPE html>
<html>
<head>
    <title>Makeup</title>
    <link rel="stylesheet" href="style.css">
 
    <script src="makeup.js"></script><!-- Сам Мейкап -->
    <link rel="stylesheet" href="makeup.css"> <!-- Стили Мейкапа -->
</head>
<body>
    <div style="display: none;">
        <button class="button">My button</button>
    </div>
</body>
</html>

Инициализируйте Мейкап

Makeup(params, templating);

где params - опциональный объект параметров, включая список блоков. Если объект не передан, все параметры берутся со значениями по-умолчанию, а список блоков генерируется из имеющегося в текущий момент DOM-дерева; templating - опциональная функция, которая по имени блока (и параметрам этого блока) должна возвращать html этого блока:

templating(ctx) {
    return html;
};

где ctx - объект, идентифицирующий выбранный в списке блок и его параметры; return - html код выбранного блока. Если функция не передана, используется встроенная функция, которая просто ищет в имеющемся DOM-дереве $('.' + ctx.name) и берёт от него outerHTML.

Формат данных для инициализации

Примеры

Все примеры можно найти в папке demo: достаточно открыть в браузере один из html файлов.

Сборка

Если вы хотите разрабатывать сам Мейкап, то... Для сборки должны быть установлены nodejs, npm и gulp.

  1. Склонируйте репозиторий

    git clone git@github.com:2gis/makeup.git
    cd makeup
  2. Запустите сборку

    npm i
    npm start

Демо будет доступно по адресу localhost:3333/demo.

Горячие клавиши в интерфейсе Makeup

До 23 октября 2015 года под именем «makeup» в npm находился другой проект — «node-makeup». Вы можете получить доступ к проекту «node-makeup» в гите.

Another project ("node-makeup") has been published in npm with name "makeup" till 23.10.2015. You can find previous project in github with name "node-makeup".

Readme

Keywords

none

Package Sidebar

Install

npm i makeup

Weekly Downloads

0

Version

1.0.1

License

MPL 2.0

Last publish

Collaborators

  • artem.malko
  • chaptykov
  • defunctzombie