Plik package.json zawiera meta dane szablonu.

Informacje ogólne

Plik package.json jest plikiem wymaganym i zawiera niezbędne informacje o Twoim motywie.  Aktualizuj ten plik na bieżąco odpowiednimi informacjami na temat  Twojego szablonu.

Aby zapoznać się z działającym przykładem pliku  package.json, możesz zapoznać się z plikiem  package.json  szablonu Casper, a w celu uzyskania dodatkowych informacji o pliku package.json, przeczytaj dokumentację npm.

Przykład

package.json

{
    "name": "your-theme-name",
    "description": "A brief explanation of your theme",
    "version": "0.5.0",
    "engines": {
        "ghost-api": "v3"
    },
    "license": "MIT",
    "author": {
        "email": "your@email.here"
    },
    "config": {
        "posts_per_page": 10,
        "image_sizes": {}
    }
}

Dane w pliku muszą być zgodne z formatem JSON, włączając w to podwójne cudzysłowy wokół wszystkich nazwy składników (właściwości) obiektów. Każda pozycja oprócz ostatniej powinna być oddzielona przecinkiem.

Dodatkowe parametry

Oto niektóre z najpopularniejszych, opcjonalnych ustawień, które mogą być użyte w plikupackage.json:

  • config.posts_per_page - domyślna ilość postów na stronie wynosi 5, możesz ustawić własną ilość przy pomocy tej właściwości,
  • config.image_sizes - aby uzyskać więcej szczegółów, zapoznaj się z poradnikiem dotyczącym obrazów responsywnych,
  • engines.ghost-api - wskazuje, z jaką wersją Ghost Content API twój motyw jest kompatybilny, domyślnie to v0.1,
  • description - podaj krótki opis twojego motywu i napisz co czyni go unikalnym,
  • license - rodzaj licencji, proponujemy MIT 😉

Zmiany w package.json wymagają restartu, aby to zrobić użyj polecenia ghost restart.

Kolejne kroki

Na tym kończymy wprowadzenie i ogólny przegląd zagadnień związanych z motywami CMS Ghost. W pozostałej części  dokumentacji wyjaśnimy, jak działają konteksty i omówimy pełną listę dostępnych helperów, które pomogą w tworzeniu Twojego szablonu.

W celu uzyskania pomocy zapraszamy na forum społeczności Ghost.