Malvid

Malvid

Benutzeroberfläche, um Webkomponenten zu erstellen und zu dokumentieren.

Inhalt

• ? Fangen an
• ? Einführung
• ? Links
• Dokumentation

Fangen an

Führung

Malvid kann auf zwei Arten in Ihr Projekt integriert werden: Verwenden der CLI oder Verwendung der API von Malvid. Weitere Informationen finden Sie in unserem Leitfaden. Beginnen Sie mit Malvid »

Demo

Die Website von Malvid ist Open-Source und vollständig mit Malvid gebaut. Sie können sich die Komponenten ansehen und wie sie im Repository der Website hergestellt werden.

Einführung

Was ist Malvid?

Malvid hilft Ihnen, Komponenten zu erstellen, zu dokumentieren und visualisieren, indem Sie ein Verzeichnis in eine interaktive Benutzeroberfläche verwandeln.

Wie funktioniert es?

1. Sie führen Malvid über die CLI oder die API aus
2. Malvid scannt den von Ihnen angegebenen Ordner und erzeugt eine statische HTML -Ausgabe
3. Sie öffnen die Ausgabe in Ihrem Browser, um Ihre Komponenten zu durchsuchen

Warum Malvid?

• Es visualisiert Komponenten auf eine Weise, die die Arbeit Ihres Teams mit Komponenten verbessert
• Es zwingt Sie nicht, eine definierte Verzeichnisstruktur, eine Vorlagensprache oder ein Build -Tool zu verwenden
• Es integriert sich perfekt in Rosid
• Es basiert auf beliebten Modulen wie React
• Es ist leicht und umfasst nur das, was es wirklich braucht

Was sind Komponenten?

Komponenten sind unabhängige und wiederverwendbare Teile eines Projekts. Eine Komponente könnte ein kleiner Teil von HTML, eine ganze Seite oder etwas dazwischen sein. Malvid erzwingt keine spezifischen Vorlagenmotor- oder Benennungskonventionen für diese Komponenten.

Links

Kesselplatten:

• ? Skelettkomponenten: UI für Komponenten in Nunjucks, JS (mit Babel, Uglifyjs) und Sass (mit CSSNano, Autoprefixer)

Führer:

• ? Fangen an
• ? Integrationen
• ? Registerkarte Inspektor

Ressourcen:

• ??? Skalierbare Frontendungen mit Webkomponenten und Malvid
• ? Teilen von Komponenten zwischen Front-End und Back-End
• ? StyleGuide

Ähnliche Werkzeuge:

• ? Fraktal
• ? Musterlabor

Standorte von Malvid angetrieben:

• ? Malvid
• ? Commerz Real Ag

Dokumentation

Anforderungen

Malvid hängt von ...

• Node.js (v8.9.0 oder neuer)
• NPM

Stellen Sie sicher, dass Sie alle Abhängigkeiten installieren und aktualisieren, bevor Sie Malvid einrichten.

Schnittstelle

Die Schnittstelle von Malvid konzentriert sich auf Ihre Komponenten. Dieses Kapitel gibt Ihnen einen Überblick über seine Möglichkeiten. Schnittstelle »

Hotkeys

Navigieren Sie mit den von Malvid bereitgestellten Hotkeys durch Ihre Komponenten. Hotkeys »

API

Malvid kann mit seiner API oder CLI in Ihr Projekt integriert werden. Die API bietet Ihnen mehr Flexibilität und ermöglicht es Ihnen, Malvid in Ihrer vorhandenen Asset -Pipeline oder in Ihrer Toolset zu verwenden. API »

Cli

Die CLI von Malvid befindet sich im bin und ermöglicht es Ihnen, Malvid auszuführen, ohne Ihrem Projekt JS -Dateien hinzuzufügen. Dieser Ansatz ist einfacher als die Verwendung der API, bietet jedoch weniger Flexibilität. Cli »

Komponenten

Malvid scannt Ordner und erkennt alle Komponenten in der angegebenen Struktur. In diesem Kapitel wird erläutert, wie Sie Komponenten speichern und verwalten und mithilfe einer Konfigurationsdatei zusätzliche Informationen zur Benutzeroberfläche hinzufügen. Komponenten »

Integrationen

Mit der API von Malvid können Sie Ihre vorhandene Asset -Pipeline oder Ihr Toolset zusammen mit Malvid verwenden. Dies umfasst Rosid-, Gulp-, NPM -Skripte und andere Systeme. Integrationen »

Optionen

Wenn Sie mehr Kontrolle über Malvid wünschen, geben Sie ein Objekt von Optionen an. Optionen »

FAQ

Antworten auf häufig gestellte Fragen. FAQ »