Toolverse
Wszystkie skille

vitepress

autor: antfu

Generator statycznych stron dokumentacji z Vue i Vite — szybki, oparty na komponentach

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Autor
antfu
Kategoria
Frontend
Wyświetlenia
1

O skillu

VitePress to generator stron statycznych zbudowany na Vite i Vue 3. Przekształca pliki Markdown w szybkie strony dokumentacji z wbudowaną obsługą komponentów Vue, wyszukiwaniem i domyślnym motywem. Idealny do tworzenia dokumentacji, blogów i stron marketingowych. Obsługuje routing oparty na plikach, natychmiastowe odświeżanie (HMR poniżej 100ms) i integrację z Algolią.

Jak używać

  1. Zainstaluj VitePress w swoim projekcie, używając komendy init, która utworzy strukturę katalogów .vitepress/config.ts i .vitepress/theme/ — tam będą przechowywane konfiguracja i motywy.

  2. Utwórz pliki Markdown w głównym katalogu projektu; VitePress automatycznie mapuje je na trasy na podstawie struktury plików — każdy plik .md staje się stroną.

  3. Dodaj komponenty Vue bezpośrednio do treści Markdown — możesz używać Vue 3 i skryptów setup w ramach dokumentacji bez dodatkowej konfiguracji.

  4. Skonfiguruj metadane witryny w .vitepress/config.ts — zdefiniuj tytuł, opis, nawigację i ustawienia wyszukiwania (lokalne lub Algolia).

  5. Uruchom serwer deweloperski komendą dev — otrzymasz natychmiastowe odświeżanie zmian w edytorze, a następnie zbuduj statyczną witrynę komendą build do wdrożenia.

Podobne skille