Εγκατάσταση

Πρότυπο Εκκίνησης

Το Slidev απαιτεί Node.js >=14.0

Ο καλύτερος τρόπος για να ξεκινήσετε είναι να χρησιμοποιήσετε το επίσημο πρότυπο εκκίνησης μας.

Με NPM:

$ npm init slidev@latest

Με Yarn:

$ yarn create slidev

Ακολουθήστε τις οδηγίες και θα ανοίξει αυτόματα η προβολή διαφανειών στη διεύθυνση http://localhost:3030/.

Περιέχει επίσης το βασικό setup και ένα σύντομο demo με οδηγίες για το πώς να ξεκινήσετε με το Slidev.

Εγκαταστήστε Χειροκίνητα

Αν εξακολουθείτε να προτιμάτε να εγκαταστήσετε το Slidev χειροκίνητα ή θα θέλατε να το ενσωματώσετε στα υπάρχοντα έργα σας, μπορείτε να το κάνετε:

$ npm install @slidev/cli @slidev/theme-default
$ touch slides.md
$ npx slidev

Παρακαλείστε να σημειώσετε ότι εάν χρησιμοποιείτε pnpm, θα πρέπει να ενεργοποιήσετε την επιλογή shamefully-hoist για να λειτουργήσει σωστά το Slidev:

echo 'shamefully-hoist=true' >> .npmrc

Εγκαταστήστε Globally

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

Μπορείτε να εγκαταστήσετε το Slidev globally με την ακόλουθη εντολή

$ npm i -g @slidev/cli

Και στη συνέχεια χρησιμοποιήστε slidev παντού χωρίς να δημιουργείτε ένα έργο κάθε φορά.

$ slidev

Αυτή η εντολή θα προσπαθήσει επίσης να χρησιμοποιήσει το τοπικό @slidev/cli εάν έχει βρεθεί στο node_modules.

Εγκατάσταση σε Docker

Αν χρειάζεστε έναν γρήγορο τρόπο για να εκτελέσετε μια παρουσίαση με containers, μπορείτε να χρησιμοποιήσετε την προκατασκευασμένη εικόνα docker που συντηρείται από τον tangramor, ή φτιάξτε το δικό σας.

Απλά εκτελέστε την ακόλουθη εντολή στο φάκελο εργασίας σας:

docker run --name slidev --rm -it \
    --user node \
    -v ${PWD}:/slidev \
    -p 3030:3030 \
    tangramor/slidev:latest

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

Μπορείτε να έχετε πρόσβαση στις διαφάνειές σας από το http://localhost:3030/

Δημιουργία εικόνας που μπορεί να γίνει deploy

Ή μπορείτε να δημιουργήσετε το δικό σας slidev project σε μία εικόνα docker με ένα Dockerfile:

FROM tangramor/slidev:latest

ADD . /slidev

Δημιουργήσετε την εικόνα docker: docker build -t myppt .

Και εκτελέστε το container: docker run --name myslides --rm --user node -p 3030:3030 myppt

Μπορείτε να επισκεφθείτε τις διαφάνειές σας από το http://localhost:3030/

Κατασκευή φιλοξενήσιμης εφαρμογής SPA (Single Page Application)

Εκτελέστε την εντολή docker exec -i slidev npx slidev build στο τρέχον container slidev. Θα δημιουργήσει στατικά αρχεία HTML στο φάκελο dist.

Φιλοξενήστε στο Github Pages

Μπορείτε να φιλοξενήσετε το dist σε μια στατική ιστοσελίδα όπως το Github Pages ή το Gitlab Pages.

Επειδή στο Github pages το url μπορεί να περιέχει υποφακέλους, πρέπει να τροποποιήσετε το παραγόμενο index.html για να αλλάξετε το href="/assets/xxx σε href="./assets/xxx. Ή μπορείτε να χρησιμοποιήσετε την επιλογή --base=/<subfolder>/ κατά τη διάρκεια της διαδικασίας κατασκευής, όπως: docker exec -i slidev npx slidev build --base=/slidev_docker/.

Και για να αποφύγετε τη διαδικασία κατασκευής του Jekyll, πρέπει να προσθέσετε ένα κενό αρχείο .nojekyll.

Φιλοξενήστε σε docker

Μπορείτε επίσης να το φιλοξενήσετε μόνοι σας με docker:

docker run --name myslides --rm -p 80:80 -v ${PWD}/dist:/usr/share/nginx/html nginx:alpine

Ή δημιουργήστε μια στατική εικόνα με ένα Dockerfile:

FROM nginx:alpine

COPY dist /usr/share/nginx/html

Δημιουργήσετε την εικόνα docker: docker build -t mystaticppt .

Και εκτελέστε το container: docker run --name myslides --rm -p 80:80 mystaticppt

Μπορείτε να επισκεφθείτε τις διαφάνειές σας από το http://localhost/

Ανατρέξτε στο tangramor/slidev_docker για περισσότερες πληροφορίες.

Περιβάλλον Γραμμής Εντολών (CLI)

@slidev/cli Εκθέστε μερικές εντολές που μπορείτε να χρησιμοποιήσετε με το npx slidev ... ή προσθέτοντας scripts στο package.json:

{
  "script": {
    "dev": "slidev"
  }
}

Σε αυτή την περίπτωση θα μπορείτε να εκτελέσετε npm run dev.

Μπορείτε να περάσετε επιλογές σε οποιεσδήποτε εντολές:

  • η επιλογή boolean είναι true αν είναι παρούσα, αλλιώς είναι false (για παράδειγμα: slidev --open)
  • ορισμένες επιλογές μπορούν να έχουν τιμές που μπορείτε να προσθέσετε ακριβώς μετά την επιλογή ή χρησιμοποιώντας τον χαρακτήρα = (για παράδειγμα: slidev --port 8080 ή slidev --port=8080)

Αν χρησιμοποιείτε npm scripts, μην ξεχάσετε να προσθέσετε -- μετά την εντολή npm:

npm run slidev -- --open

slidev [entry]

Ξεκινήστε έναν τοπικό διακομιστή για το Slidev.

  • [entry] (string, προεπιλογή: slides.md): το path για την είσοδο διαφανειών markdown.

Επιλογές:

  • --port, -p (number, προεπιλογή: 3030): αριθμός port.
  • --open, -o (boolean, προεπιλογή: false): άνοιγμα στο πρόγραμμα περιήγησης.
  • --remote [password] (string): ακούει τον public host και ενεργοποιεί τον απομακρυσμένο έλεγχο, εάν περαστεί μια τιμή, τότε η λειτουργία του παρουσιαστή είναι ιδιωτική και προσβάσιμη μόνο με τη διαβίβαση του συγκεκριμένου κωδικού πρόσβασης στην παράμετρο password του URL query.
  • --log ('error', 'warn', 'info', 'silent', προεπιλογή: 'warn'): επίπεδο καταγραφής δεδομένων.
  • --force, -f (boolean, προεπιλογή false): αναγκάζει τον βελτιστοποιητή να αγνοήσει την προσωρινή μνήμη και να κάνει re-bundle.
  • --theme, -t (string): παρακάμπτει το θέμα.

slidev build [entry]

Κατασκευή φιλοξενήσιμου SPA.

  • [entry] (string, προεπιλογή: slides.md): το path για την είσοδο διαφανειών markdown.

Επιλογές:

  • --watch, -w (boolean, προεπιλογή: false): παρακολούθηση κατασκευής.
  • --out, -o (string, προεπιλογή: dist): φάκελος εξόδου.
  • --base (string, προεπιλογή: /): base URL (δείτε https://cli.vuejs.org/config/#publicpath)
  • --download (boolean, προεπιλογή: false): επιτρέπει τη λήψη των διαφανειών σε μορφή PDF μέσα στο SPA.
  • --theme, -t (string): παρακάμπτει το θέμα.

slidev export [entry]

Εξαγωγή διαφανειών σε PDF (ή άλλη μορφή).

  • [entry] (string, προεπιλογή: slides.md): το path για την είσοδο διαφανειών markdown.

Επιλογές:

  • --output (string, προεπιλογή: χρησιμοποιήστε το exportFilename (δείτε https://el.sli.dev/custom/#ρυθμίσεις-frontmatter) ή χρησιμοποιήστε [entry]-export): το path για την εξαγωγή.
  • --base ('pdf', 'png', 'md', προεπιλογή: 'pdf'): μορφή εξόδου.
  • --timeout (number, προεπιλογή: 30000): χρονικό όριο για την απεικόνιση της σελίδας εκτύπωσης (δείτε https://playwright.dev/docs/api/class-page#page-goto).
  • --range (string): περιοχές σελίδων για εξαγωγή (για παράδειγμα: '1,4-5,6').
  • --dark (boolean, προεπιλογή: false): εξαγωγή με σκοτεινό θέμα.
  • --with-clicks, -c (boolean, προεπιλογή: false): εξαγωγή σελίδων για κάθε κλικ (δείτε https://el.sli.dev/guide/animations.html#κινήσεις-click).
  • --theme, -t (string): παρακάμπτει το θέμα.

slidev format [entry]

Διαμορφώστε το αρχείο markdown.

  • [entry] (string, προεπιλογή: slides.md): το path για την είσοδο διαφανειών markdown.

slidev theme [subcommand]

Λειτουργίες που σχετίζονται με το θέμα.

Υποεντολές:

  • eject [entry]: Εξαγωγή του τρέχοντος θέματος στο τοπικό σύστημα αρχείων
    • [entry] (string, προεπιλογή: slides.md): το path για την είσοδο διαφανειών markdown.
    • Επιλογές:
      • --dir (string, προεπιλογή: theme): φάκελος εξόδου.
      • --theme, -t (string): παρακάμπτει το θέμα.