Phenquestions
Standard Markdown
Markdown er en standard udviklet af John Gruber. Hovedmålet med Markdown er at gøre filen mulig at læse selv i ren tekst. Hvis du vil kigge i en tekstbeskyttet editor, skal du have en let tid på at læse den. Dette er meget nyttigt for brugere af vim og lignende. Bemærk, og husk, at dette er en standard til ændring af tekstfiler. Det erstatter ikke HTML. I stedet bruger du det til at oprette HTML, hvor det er nyttigt. I tilfælde af GitHub vil de formatere Readme-filen på webstedet. Så længe du følger standarden, kan du føle dig sikker på, at den vil se godt ud.
Da GitHub kun har tilføjet et par udvidelser, skal du starte med at bruge et Markdown-cheatsheet og gå derfra. Her er en liste over de mest almindelige.
| Markdown | Udvidelser | Resultat |
| # (1 pr. Niveau) | Overskrifter | |
| * | Kursiv | |
| ** | Fremhævet | |
| > | Blockquote | |
| 1. (etc.) | Bestilt liste | |
| - | Uordnet liste | |
| 'kode' | Din kode | |
| “' | Md-ekst | Start og afslut en kodeblok |
| - | Vandret regel | |
| [Beskrivelse] (https: // www.eksempel.com) | Et navn i firkant og URL i almindelige parenteser | |
| ![alt tekst] (billede.png) | Samme, link til et billede | |
| [1] | Md-ekst | En fodnote |
Listerne kan indlejres ved at indrykke de emner, du vil have indlejret.
Andre udvidelser til almindelig Markdown, du har koden blokerer udvidelser ovenfor. De understøttes ikke altid af tjenester.
| Markdown | Udvidelser | Resultat |
| ### Overskrift # custom-id | Md-ekst | En overskrift, som du kan adressere med dens id |
| udtryk: definition | Md-ekst | En liste over termer med definitioner |
| ~ Fejltekst ~ | Md-ekst | Gennemtrængende tekst |
| - [x] Opgave at gøre | Md-ekst | En opgaveliste, du kan markere |
Tabellen er meget enkel, men du har brug for flere rækker for at vise den: Tabel:
| Navn | VÆRDI || ----------- | ---------- |
| Måtter | 100 |
GitHub-udvidelser.
GitHub har tilføjet et par udvidelser for at gøre det nemmere at håndtere links til andre mennesker og projekter. Nogle af disse er de tidligere nævnte tabeller. Den der hjælper dig mest er udvidelsen auto-link. Det opretter et link alene, når du bruger det på GitHub.
Andre er tabeller og opgavelisteelementer. Disse er praktiske til at holde styr på dine opgaver i projekter. Den sidste at nævne er Disallowed Raw HTML-udvidelsen. Ved hjælp af denne udvidelse filtreres nogle tags, når de gengives til HTML. Disse tags kan forårsage mærkelige effekter, når de gengives til GitHub.
Måder at udforske GitHub Markdown
Hvis du finder det forvirrende, kan du også gå til GitHub-siden og bruge den indbyggede editor. Når du bruger det, udfylder det nogle funktioner automatisk. Dette fungerer kun til problemer, men du kan bruge det til at finde ud af nogle ting, emojis kommer ud som en liste, når du skriver et kolon (:).
Du kan også finde et projekt på GitHub, der har en flotte README-fil og klone det til dit lokale drev. Derfra kan du udforske filen ved hjælp af en hvilken som helst editor. For de store redaktører, Emacs og Vim, er der understøttelse af markdown gennem udvidelser.
Hvis du bruger vim, kan du indsætte en syntaksfremhævelsesudvidelse fra GitHub, vim-markdown. Denne udvidelse viser dig, at du har gjort koden korrekt. For at hjælpe dig med at se, hvordan det ser ud, når du er færdig, kan du også få udvidelsen til live-mærke. Med dette kan du have en webserver kørende, der viser resultatet live, mens du skriver.
Med Emacs har du utålmodig tilstand, live down-tilstand og Realtime-preview. De viser alle din resulterende side i en browser, mens du skriver. Den første kræver færre biblioteker end sidstnævnte, men har brug for et ekstra kodestykke for at køre.
Konklusion
Selvom markdown er en lille og bevidst enkel specifikation, kan det være lidt forvirrende at komme i gang med. Den bedste måde at lære er at bruge et snydeark og skrive dit Markdown-dokument. Du kan opdatere din README.md på GitHub, og du kan få meget støtte fra dine redaktørers indbyggede funktioner. Som en sidebemærkning understøtter GitHub også emojis, som du kan tilføje til dit dokument. Du kan bruge snydearket til at finde, hvilke de er.
Download Markdown-CheatSheet Here
