Jak prawidłowo zamieszczać YAML, inny kod lub logi w postach na forum

Przede wszystkim NIE należy używać cytowania!

nie cytować 2024-01-23_22-33


Niestety podstawowy znacznik bloku kodu nie znajduje się w podręcznym menu (obecnie już jest, ale i tak warto znać metody używania tego bez użycia menu - choćby do użytku na githubie) - są to w najprostszym przypadku dwie identyczne osobne linijki - jedna przed blokiem kodu, a druga za nim, w obu wystarczy umieścić po trzy odwrotne apostrofy, to ten znak który na standardowej amerykańskiej klawiaturze (czytaj: “polskiej-programisty”) jest na klawiszu, który obrysowałem na zielono:

klawisz tyldy 2024-01-23_22-56
tradycyjnie ten klawisz bywa zwany klawiszem tyldy, mimo, że tylda ~ jest dostępna na “drugiej układce” tj. z shiftem - mówiąc prosto chodzi o coś takiego: ```
tyle, że umieszczone w osobnej linii. (ze względów technicznych nie można tego napisać by było równocześnie widoczne w poście, a blok kodu w bloku kodu w innym formatowaniu wygląda i tak źle…)

edit
NIE chodzi o zwykły apostrof, ani o cudzysłów… (czyli żaden z tych dwóch, które mamy wspólnie na klawiszu zwykle w okolicach Entera)

edit: Po aktualizacji forum można skorzystać z podręcznego menu do ujęcia kodu wieloliniowego w znaczniki “półautomatycznie” - zaznaczamy cały blok kodu (jeden) i używamy narzędzia Tekst formatowany dostępnego jako pierwsze narzędzie “pod trybikiem”, jeśli mamy więcej bloków kodu czynność powtarzamy dla każdego z nich
trybik-2024-02-09_15-10

Stosowanie tego formatowania jest bardzo ważne, bo YAML (w którym każda spacja jest ważna) nie umieszczony w znacznikach kodu zostaje całkowicie zniszczony mechanizmami markdown.

Oto przykład - tu w znacznikach

items:
  - things:
      thing1: huey
      things2: dewey
      thing3: louie
  - other things:
      key: value

a tu to samo bez nich

items:

  • things:
    thing1: huey
    things2: dewey
    thing3: louie
  • other things:
    key: value

Chyba nie wymaga to komentarza…


W menu ukrytym od ikoną trybika są dostępne inne narzędzia, w tym narzędzie Tekst sformatowany które dodaje pojedyncze odwrotne apostrofy tak aby objęły zaznaczenie, można je wykorzystać aby oznaczyć np. jakieś polecenie, które mieści się w jednej linii i jest stosunkowo krótkie.
Oto przykład na takie wyróżnienie ha os update --version 11.4 niestety to narzędzie nie nadaje się do jakiegokolwiek kodu zawierającego więcej niż jedną linijkę, ani do niczego realnie długiego.


W postach na forum generalnie działa formatowanie Markdown


Od biedy można też użyć BBCode (to dla starych forumowych wyjadaczy - zgodność ze znacznikami stosowanymi od wieków)


Do formatowania można też używać zwykłych znaczników HTML.


ALE

Zalecam Markdown, on działa też na githubie i na wszystkich innych forach bazujących na Discourse (w tym oficjalnym forum HA czy forum AIS).

1 Like