Skip to content

Latest commit

 

History

History
117 lines (76 loc) · 3.43 KB

README.md

File metadata and controls

117 lines (76 loc) · 3.43 KB
Raw

Kir-Dev blog

A kir-dev.sch.bme.hu tartalma.

Telepítés

Bare metal

Legyen telepítve ruby és jekyll a gépeden. A jekyll gemként telepíthető. Tehát ha már van ruby-d:

gem install jekyll

Ha az előkövetlemények megvannak, akkor

git clone https://github.com/kir-dev/kir-dev.sch.bme.hu.git kirdev-blog
cd kirdev-blog
jekyll serve --watch

A böngésződben pedig a localhost:4000-en tudod megnézni a blogot.

Docker

git clone https://github.com/kir-dev/kir-dev.sch.bme.hu.git kirdev-blog
cd kirdev-blog
docker-compose up

Ekkor a localhost:3333-as címen lesz elérhető.

Ha daemonként szeretnénk indítani a docker containert, akkor ezt a docker-compose up paranccsal tehetjük meg. Leállítani a docker-compose stop paranccsal tudjuk.

Új bejegyzés létrehozása

  1. Hozz létre egy új branchet a bejegyzésednek.

     git checkout -b my-awesome-post-draft

  2. A _posts mappába hozz létre egy új fájlt. A fájlnév formátuma a következő:

     2013-12-22-a-bejegyzes-cime.md

    A megfelelő részek értelemszerűen módosítandóak.

  3. Pushold fel a githubra és csinálj egy pull requestet, majd szólj valakinek, hogy nézze meg.

     git push -u origin my-awesome-post-draft

  4. Javítsd a bejegyzést, ha szükséges.

  5. Ismételd a 3-as és 4-es pontot, amíg szükséges.

  6. Mergeld a pull requestet a masterbe.

Alternatívaként elkezdtük használni a draft nevű szolgáltatást. Itt is megírhatod a cikked, majd valaki átnézheti. Ezzel átugorhatjuk majdnem a teljes előző folyamatot. Ha kész a cikk, rögtön mehet master-be.

Új bejegyzés sablonja

A "front matter", vagyis a bejegyzéshez tartozó meta adatok a következők lehetnek:

  • layout (kötelező): a bejegyzés sablon. Jelenleg egy van: post
  • title (kötelező): a bajegyzés címe
  • author (kötelező): a bejegyzés szerzője. Használd a PÉKben is megtalálható felhasználóneved, mert erre linkelünk a sablonból.
  • date (opcionális): a bejegyzés dátuma. Célszerű megadni, mert különben a fájl nevében megadott dátumot használja és az órát 00:00:00-ra állítja. FONTOS ha megadod a dátumot, akkor az időzónát se felejtsd el. A mi időzónánk a CET.
  • comment (opcionális): true érték esetén komment szekciót is renderel a bejegyzés oldalára
  • category (opcionális): a bejegyzés kategóriája. A #3 issue szól erről, egyelőre ad-hoc jelleggel történik.

A teljes paraméter lista itt megtalálható.

Bejegyzés sablon

---
layout: post
title:  "A bejegyzés címe"
author: tmichel
date:   2013-12-22 20:00:00 CET
---

A bejegyzés tartalma markdownban.

Kommentek a bejegyzés alatt

Ehhez a comment: true kapcsolót tegyük be a többi fejlécben található beállítás közé

---
layout: post
title:  "A bejegyzés címe"
author: tmichel
date:   2013-12-22 20:00:00 CET
comment: true
---

License

The following directories and their contents are Copyright Kir-Dev. You may not reuse anything therein without Kir-Dev's permission:

  • _posts/
  • _drafts/
  • img/

All other directories and files are MIT Licensed.