Elérhető: https://numichi.dev
Az oldal egy Markdown alapú VitePress engine generál és GitHup Page hosztol.
Gondolom látni szeretnéd, hogy az oldalad hogyan fog kinézni, mielőtt hozzájárulnál az oldalhoz. Ehhez a következőket kell tenned:
yarn install # vagy npm install / pnpm install
Ezután a következő paranccsal indíthatod az oldalt:
yarn docs:dev # vagy npm run docs:dev / pnpm docs:dev
Megjegyzés: A GitHub Action
yarn
-t használ a build során.
Minden leírást megtalálható VitePress dokumentációban, de kiemek pár hasznosabbat:
- Routing
- Markdown Extensions
- Last Updated-et manuálisan kell átírni UTC idő szerint, ha van dátum. A VitePress magyar időzóna szerint rászámol még 1 (vagy nyári szerint 2) órát.
- Routing esetén az URL-ek legyenek magyarul
- Meta leírások és címek is legyenek magyarul
Az alap megközelítés az, hogy magyarok által írt oldal magyaroknak, közben feltételezve azt, hogy az olvasók nem minden esetben ismerhetik az angol nyelvet vagy bizonyos IT szakszavakat. Így minden esetben hivatkozni vagy zárójelben szükséges megmagyarázni az annak jelentését.
Mindezek mellet az oldalhoz hozzájárulók szabadon használhatják a saját stílusukat, de a tartalomnak érthetőnek és követhetőnek kell lennie.