Útmutatók

Leírás oldal képekkel

Ha a szerver projekt mappájában van README.md, a build a csomag wwwroot/readme/ mappájába teszi, a docs/ mappa tartalmával együtt. A Komod tár weboldala a Komod oldalán, a KOFA alkalmazás a Komod tár kártyán (Leírás gomb) mutatja.

Acme.Demo.Thermostat/
  README.md           Markdown: címek, listák, táblázatok, kódblokkok, linkek, képek
  docs/kepernyo.png   a README így hivatkozza: ![Csempe](docs/kepernyo.png)

Szabályok

• Képek: png, jpg, gif, webp, csak a docs/ mappából, relatív útvonallal. Külső (https://) kép is mehet.
• Biztonság: nyers HTML nem kerül át, escape-elve szövegként jelenik meg. Link csak http(s) vagy mailto lehet, és új lapon nyílik.
• Méret: a README.md legfeljebb 256 KB.
• Kompatibilitás: a leírás a wwwroot/ alatt van, így régebbi KOFA szerver is telepíti a csomagot. Leírás nélküli csomagnál semmi nem változik.

Mit írj bele

A tár oldalán ez az első, amit a felhasználó lát: mire való a Komod, a portok táblázata (azonosító, irány, típus, jelentés), a beállítások, bekötési példa, és hardver esetén a kapcsolási rajz. A sablon README.md-je ennek vázát adja.

A Komod kategóriája a [Komod(Category = KomodCategory.X)] attribútumból jön; a tár ez alapján szűr.