Toolverse
Wszystkie skille

woocommerce-markdown

autor: woocommerce

Wytyczne do tworzenia dokumentacji markdown zgodnie ze standardami WooCommerce

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Frontend
Wyświetlenia
1

O skillu

Skill zawiera reguły i standardy dla plików markdown w projekcie WooCommerce. Użyj go podczas pisania dokumentacji, plików README lub innej zawartości markdown. Obejmuje konfigurację markdownlint, zasady formatowania nagłówków, list i bloków kodu, a także wymagania dotyczące kodowania UTF-8 i struktury plików. Zapewnia, że Twoja dokumentacja będzie spójna z wytycznymi projektu i przejdzie automatyczną walidację.

Jak używać

  1. Zainstaluj skill woocommerce-markdown w swoim środowisku pracy. 2. Przed rozpoczęciem edycji pliku markdown zapoznaj się z krytycznymi regułami: zawsze uruchamiaj markdownlint z katalogu głównego repozytorium, aby załadować plik konfiguracyjny .markdownlint.json, używaj kodowania UTF-8 zwłaszcza dla drzew katalogów i znaków specjalnych. 3. Podczas pisania dokumentacji stosuj wytyczne formatowania: używaj stylu ATX dla nagłówków (# Nagłówek zamiast podkreślenia), utrzymuj hierarchię nagłówków bez pomijania poziomów, stosuj 4 spacje do wcięcia list zagnieżdżonych, otaczaj bloki kodu pustymi liniami, zawsze podawaj język dla bloków kodu. 4. Po każdej zmianie uruchom polecenie markdownlint --fix aby automatycznie naprawić błędy, a następnie markdownlint aby zweryfikować, że wszystkie reguły są spełnione. 5. Pamiętaj że pliki muszą kończyć się pojedynczą nową linią, tabulatory są dozwolone, a znaki specjalne HTML są dozwolone tylko dla elementów wideo. 6. Jeśli dokumentacja zawiera wiele nagłówków o tej samej nazwie, mogą one występować w różnych sekcjach (reguła MD024 pozwala na to).

Podobne skille