PIXI til dokumentation
Vejledningen er en skalerbar skabelon, der er sat op til at hjælpe OS2 projekter og produkter med at bygge gode overskuelige dokumentationssider.Skabelonen hjælper med en hurtig opstart og understøtter en stabil struktur.
Vejledningen er opdelt i 12 trin, som ses i menuen.
Hvis du ikke har en bruger på GitHub, skal du oprette en først: https://github.com
Vejledning som pdf
Hvordan kan du bruge siden
Under menupunktet Trin | samlet er det meste af koden sat op med html for at lave trinene, så de kan foldes ud. Billeder og link er også lagt ind med html. Den grå/lilla boks i toppen af forsiden er lagt ind med html og en smule css.
Menupunkterne Trin 1 - 12 er sat op med markdown og billeder og link er lagt ind med markdown.
Filtype: Alle filer er markdownfiler og gemmes som .md
Adskild filnavne der består af flere ord med underscore, FX my_first_page.md
Linjeskift kan i markdown laves med to linjeskift og i både markdown og html med <br>
Menupunkterne: fremstår som et mappetræ i github, det kan ses her - alle mapperne i denne PIXI indeholder kun én fil: index, hvilket er den første fil, der altid kigges efter, når siden renderes. Man kan sagtens have flere filer.
Header: Der skal altid skrives en header i filen, ellers vises den ikke - se hvordan man gør i filerne.
Man kan se, hvordan siden og ændringer ser ud under fanen/tab: Preview og foretage ændringer ved at vælge fanen/tab: Edit og/eller blyant.
Der er i denne PIXI oprettet to mapper, en til dokumenter (til download) og en til billeder. Alle de andre sider henviser til dokumenter/billeder i disse mapper, på den måde, skal det kun vedligeholdes et sted.
Mappe og filnavne skal altid være med små bogstaver og adskilles med underscore.
Så er der bare tilbage at sige: God fornøjelse - og husk, hvis det driller, kan man altid starte forfra eller spørge en ven :smile: