Malvid

Мальвид

Пользовательский интерфейс, чтобы помочь вам создать и документировать веб -компоненты.

Содержимое

• ? Начните
• ? Введение
• ? Ссылки
• Документация

Начните

Гид

Мальвид может быть интегрирован в ваш проект двумя способами: использование CLI или использование API Malvid. Проверьте наше руководство для получения дополнительной информации. Начните с Мальвидом »

Демо

Веб-сайт Malvid находится с открытым исходным кодом и полностью построен с Malvid. Вы можете взглянуть на компоненты и то, как они сделаны в хранилище веб -сайта.

Введение

Что такое Мальвид?

Мальвид помогает вам создавать, документировать и визуализировать компоненты, превращая каталог в интерактивный пользовательский интерфейс.

Как это работает?

1. Вы выполняете Мальвид, используя CLI или используя API
2. Мальвид сканирует указанную вами папку и генерирует статический выход HTML
3. Вы открываете вывод в своем браузере, чтобы начать просматривать свои компоненты

Почему Мальвид?

• Он визуализирует компоненты таким образом, чтобы улучшить то, как ваша команда работает с компонентами
• Он не заставляет вас использовать определенную структуру каталогов, языковой язык или инструмент для строительства
• Он идеально интегрируется с розовым
• Он построен на популярных модулях, таких как React
• Он легкий и включает только то, что ему действительно нужно

Что такое компоненты?

Компоненты являются независимыми и многоразовыми частями проекта. Компонент может быть крошечным кусочком HTML, целой страницей или что -то между ними. Мальвид не обеспечивает какого -либо конкретного механизма шаблон или соглашений на именования для этих компонентов.

Ссылки

Шаблоны:

• ? Компоненты скелета: пользовательский интерфейс для компонентов, написанных в Nunjucks, JS (с Babel, Uglifyjs) и Sass (с Cssnano, Autoprefixer)

Руководства:

• ? Начните
• ? Интеграции
• ? Вкладки инспектора

Ресурсы:

• ??? Масштабируемые передние стойки с веб-компонентами и мальсидом
• ? Совместное использование компонентов между интерфейсом и задней частью
• ? Стиль

Подобные инструменты:

• ? Фрактал
• ? Паттерн Лаборатория

Сайты, работающие на Мальвиде:

• ? Мальвид
• ? Commerz Real Ag

Документация

Требования

Мальвид зависит от ...

• Node.js (v8.9.0 или новее)
• npm

Обязательно установите и обновите все зависимости перед настройкой Malvid.

Интерфейс

Интерфейс Мальвида сосредоточен на ваших компонентах. Эта глава дает вам обзор возможностей. Интерфейс »

Горячие клавиши

Перейдите через свои компоненты, используя Hotkeys, предоставленные Malvid. Горячие клавиши »

API

Malvid может быть интегрирован в ваш проект, используя свой API или CLI. API дает вам большую гибкость и позволяет использовать Malvid в вашем существующем конвейере или наборе инструментов. API »

Кли

CLI Malvid расположен в папке bin и позволяет запускать Malvid, не добавляя файлы JS в ваш проект. Этот подход проще, чем использование API, но обеспечивает меньшую гибкость. CLI »

Компоненты

Мальвид сканирует папки и обнаруживает все компоненты в данной структуре. В этой главе объясняется, как хранить и управлять компонентами и как добавить дополнительную информацию в пользовательский интерфейс с помощью файла конфигурации. Компоненты »

Интеграции

API Malvid позволяет использовать ваш существующий конвейер активов или набор инструментов вместе с Malvid. Это включает в себя Rosid, Gulp, NPM -сценарии и другие системы. Интеграции »

Параметры

Если вы хотите большего контроля над Малвидом, передайте объект параметров. Параметры "

Часто задаваемые вопросы

Ответы на часто задаваемые вопросы. ЧАСТО ЗАДАВАЕМЫЕ ВОПРОСЫ "