Malvid

Malvid

UI para ayudarlo a construir y documentar componentes web.

Contenido

• ? Empezar
• ? Introducción
• ? Campo de golf
• Documentación

Empezar

Guía

Malvid se puede integrar en su proyecto de dos maneras: usar la CLI o usar la API de Malvid. Consulte nuestra guía para obtener más información. Empiece con Malvid »

Manifestación

El sitio web de Malvid es de código abierto y está construido completamente con Malvid. Puede echar un vistazo a los componentes y cómo se hacen en el repositorio del sitio web.

Introducción

¿Qué es Malvid?

Malvid lo ayuda a construir, documentar y visualizar componentes convirtiendo un directorio en una interfaz de usuario interactiva.

¿Cómo funciona?

1. Ejecuta Malvid usando la CLI o usando la API
2. Malvid escanea la carpeta que ha especificado y genera una salida HTML estática
3. Abre la salida en su navegador para comenzar a navegar a través de sus componentes

¿Por qué Malvid?

• Visualiza los componentes de una manera que mejora cómo funciona su equipo con los componentes
• No le obliga a usar una estructura de directorio definida, lenguaje de plantilla o herramienta de compilación
• Se integra perfectamente con rosid
• Se basa en módulos populares como React
• Es liviano e solo incluye lo que realmente necesita

¿Qué son los componentes?

Los componentes son piezas independientes y reutilizables de un proyecto. Un componente podría ser una pequeña parte de HTML, una página completa o algo intermedio. Malvid no hace cumplir ningún motor de plantilla específico o convenciones de nombres para esos componentes.

Campo de golf

Boilerplates:

• ? Componentes de esqueleto: UI para componentes escritos en Nunjucks, JS (con Babel, Uglifyjs) y Sass (con CSSNano, AutoPrefixer)

Guías:

• ? Empezar
• ? Integración
• ? Pestañas del inspector

Recursos:

• ???? Front-endeses escalables con componentes web y malvid
• ? Compartir componentes entre front-end y back-end
• ? Guía de estilo

Herramientas similares:

• ? Fractal
• ? Laboratorio de patrones

Sitios alimentados por Malvid:

• ? Malvid
• ? Commerz Real AG

Documentación

Requisitos

Malvid depende de ...

• Node.js (v8.9.0 o más nuevo)
• npm

Asegúrese de instalar y actualizar todas las dependencias antes de configurar Malvid.

Interfaz

La interfaz de Malvid se enfoca en sus componentes. Este capítulo le ofrece una visión general sobre sus posibilidades. Interfaz »

Teclas de acceso

Navegue a través de sus componentes utilizando las teclas de acceso rápido proporcionadas por Malvid. Pelimas »

API

Malvid se puede integrar en su proyecto utilizando su API o CLI. La API le brinda más flexibilidad y le permite usar Malvid en su canalización o conjunto de herramientas de activos existentes. API »

CLI

La CLI de Malvid se encuentra en la carpeta bin y le permite ejecutar Malvid sin agregar archivos JS a su proyecto. Este enfoque es más simple que usar la API, pero proporciona menos flexibilidad. Cli »

Componentes

Malvid escanea las carpetas y detecta todos los componentes en la estructura dada. Este capítulo explica cómo almacenar y administrar componentes y cómo agregar información adicional a la interfaz de usuario utilizando un archivo de configuración. Componentes »

Integración

La API de Malvid le permite usar su canalización de activos existente o conjunto de herramientas junto con Malvid. Esto incluye Rosid, Gulp, Scripts NPM y otros sistemas. Integraciones »

Opción

Si desea más control sobre Malvid, pase un objeto de opciones. Opciones »

Preguntas frecuentes

Respuestas a preguntas frecuentes. Preguntas frecuentes »