Γράψτε ένα Πρόσθετο

Διαθέσιμο από v0.32.1

Δυνατότητα

Ένα πρόσθετο μπορεί να συμβάλει στα ακόλουθα σημεία:

  • Global στυλ (χρησιμοποιήστε τα με προσοχή, είναι περισσότερο ο ρόλος των θεμάτων)
  • Παροχή προσαρμοσμένων διατάξεων ή υπέρβαση της υπάρχουσας
  • Παροχή προσαρμοσμένων στοιχείων ή παράκαμψη του υπάρχοντος
  • Επέκταση των ρυθμίσεων του Windi CSS
  • Ρύθμιση εργαλείων όπως το Monaco και το Prism

Συμβάσεις

Τα πρόσθετα δημοσιεύονται στο μητρώο npm και πρέπει να ακολουθούν τις παρακάτω συμβάσεις:

  • Το όνομα του πακέτου πρέπει να αρχίζει με slidev-addon-, για παράδειγμα: slidev-addon-awesome
  • Προσθέστε slidev-addon και slidev στο πεδίο keywords του package.json σας

Setup

Αρχικοποίηση

Για να δημιουργήσετε το πρόσθετό σας, ξεκινήστε δημιουργώντας έναν φάκελο με ένα αρχείο package.json (μπορείτε να χρησιμοποιήσετε npm init).

Στη συνέχεια, εγκαταστήστε τις τα dependencies του slidev:

$ npm install -D @slidev/cli

Έλεγχος

Για να δημιουργήσετε το πεδίο δοκιμών για το πρόσθετό σας, μπορείτε να δημιουργήσετε ένα αρχείο example.md με κάποιο περιεχόμενο.

Και προαιρετικά, μπορείτε επίσης να προσθέσετε κάποια scripts στο packages.json σας

// package.json
{
  "scripts": {
    "dev": "slidev example.md",
    "build": "slidev build example.md",
    "export": "slidev export example.md",
    "screenshot": "slidev export example.md --format png"
  }
}

Για να δημοσιεύσετε το προσθετό σας, απλά εκτελέστε npm publish και είστε έτοιμοι. Δεν απαιτείται διαδικασία κατασκευής (που σημαίνει ότι μπορείτε να δημοσιεύσετε απευθείας αρχεία .vue και .ts, το Slidev είναι αρκετά έξυπνο για να τα καταλάβει).

Τα σημεία συνεισφοράς του πρόσθετου ακολουθούν τις ίδιες συμβάσεις με την τοπική ρυθμίση, παρακαλούμε ανατρέξτε στις οδηγίες για τις συμβάσεις ονομασίας.

Μεταδεδομένα πρόσθετου

Έκδοση Slidev

Εάν το πρόσθετο βασίζεται σε ένα συγκεκριμένο χαρακτηριστικό του Slidev που εισήχθη πρόσφατα, μπορείτε να ορίσετε την ελάχιστη έκδοση Slidev που απαιτείται για να λειτουργήσει σωστά το πρόσθετό σας:

// package.json
{
  "engines": {
    "slidev": ">=0.32.1"
  }
}

Εάν οι χρήστες χρησιμοποιούν παλαιότερες εκδόσεις του Slidev, θα εμφανιστεί σφάλμα.