Auf GitHub anzeigen

Bootstrap Table Build-Tools

Erfahren Sie, wie Sie die in Bootstrap Table enthaltenen npm-Skripte verwenden können, um unsere Dokumentation zu erstellen, Quellcode zu kompilieren und mehr.

Auf dieser Seite

Tooling-Setup

Bootstrap Table verwendet NPM-Skripte für sein Build-System. Unser package.json enthält bequeme Methoden für die Arbeit mit dem Framework, einschließlich Code-Linting, Code-Kompilierung und mehr.

Um unser Build-System zu verwenden und unsere Dokumentation lokal auszuführen, benötigen Sie eine Kopie der Bootstrap Table-Quelldateien und Node. Folgen Sie diesen Schritten, und Sie sollten bereit sein zu beginnen:

  1. Laden Sie Node.js herunter und installieren Sie es, das wir zur Verwaltung unserer Abhängigkeiten verwenden.
  2. Navigieren Sie zum Stammverzeichnis /bootstrap-table und führen Sie npm install aus, um unsere lokalen Abhängigkeiten, die in package.json aufgeführt sind, zu installieren.
  3. (Nur für die Dokumentationswebsite) Wenn Sie die Dokumentationswebsite einrichten möchten, navigieren Sie zum Verzeichnis /site und führen Sie npm install aus, um Astro und andere Abhängigkeiten für die Dokumentationswebsite zu installieren.

Nach Abschluss können Sie die verschiedenen von der Befehlszeile bereitgestellten Befehle ausführen.

Verwendung von NPM-Skripten

Unser package.json enthält die folgenden Befehle und Aufgaben:

AufgabeBeschreibung
npm run buildnpm run build erstellt das Verzeichnis /dist mit kompilierten Dateien.
npm run lintFührt Linting für CSS und JavaScript im Verzeichnis /src durch.
npm run testFührt die Testsuite des Projekts aus.

Führen Sie npm run aus, um alle npm-Skripte anzuzeigen.

Lokale Dokumentation

Das lokale Ausführen unserer Dokumentation erfordert die Verwendung von Astro, einem modernen statischen Seiten-Generator, der uns bietet: komponentenbasierte Architektur, Markdown-basierte Dateien, Vorlagen und mehr. So starten Sie es:

  1. Führen Sie das oben beschriebene Tooling-Setup durch, um Astro und andere Abhängigkeiten zu installieren.
  2. Navigieren Sie zum Verzeichnis /site und führen Sie npm run dev in der Befehlszeile aus.
  3. Öffnen Sie http://localhost:4321 in Ihrem Browser, um die lokale Dokumentationswebsite anzuzeigen.

Erfahren Sie mehr über die Verwendung von Astro, indem Sie seine Dokumentation lesen.

Problembehandlung

Wenn Sie Probleme bei der Installation von Abhängigkeiten haben, deinstallieren Sie alle vorherigen Abhängigkeitsversionen (global und lokal). Führen Sie dann npm install erneut aus.