GitHub Markdown Cheatheet
Standard markdown
Markdown er en standard utviklet av John Gruber. Hovedmålet med Markdown er å gjøre filen mulig å lese selv i ren tekst. Hvis du vil se i en bare tekstredaktør, bør du ha det enkelt å lese den. Dette er veldig nyttig for brukere av VIM og lignende. Legg merke til, og husk at dette er en standard for å endre tekstfiler. Det erstatter ikke HTML. I stedet bruker du den til å lage HTML der det er nyttig. Når det gjelder GitHub, vil de formatere ReadMe -filen på nettstedet. Så lenge du følger standarden, kan du føle deg sikker på at det vil se bra ut.
Siden Github har lagt til bare noen få utvidelser, bør du begynne med å bruke et markeringsarket og gå derfra. Her er en liste over de vanligste.
| Markdown | Utvidelser | Resultat |
| # (1 per nivå) | Overskrifter | |
| * | Kursiv | |
| ** | Dristig | |
| > | Blockquote | |
| 1. (etc.) | Bestilt liste | |
| - | Uordnet liste | |
| 'kode' | Koden din | |
| “' | MD-EXT | Start og avslutt en kodeblokk |
| - | Horisontal regel | |
| [Beskrivelse] (https: // www.eksempel.com) | Et navn i firkant og url i vanlige parenteser | |
| ![ALT -tekst] (bilde.png) | Samme, lenke til et bilde | |
| [1] | MD-EXT | En fotnote |
Listene kan nestes ved å innrykk av alle ting du vil ha nestet.
Andre utvidelser til regelmessig markdown, du har kodeblokker utvidelser ovenfor. De støttes ikke alltid av tjenester.
| Markdown | Utvidelser | Resultat |
| ### Heading #Custom-Id | MD-EXT | En overskrift som du kan ta opp med ID -en |
| Term: Definisjon | MD-EXT | En liste over vilkår med definisjoner |
| ~ Feil tekst ~ | MD-EXT | Strikethrough Text |
| - [x] oppgave å gjøre | MD-EXT | En oppgaveliste du kan krysse av |
Bordet er veldig enkelt, men du trenger flere rader for å vise det: Tabell:
| Navn | Verdi || ----------- | ---------- |
| MATS | 100 |
GitHub -utvidelser.
Github har lagt til noen få utvidelser for å gjøre det enklere å håndtere lenker til andre mennesker og prosjekter. Noen av disse er bordene som er nevnt tidligere. Den som vil hjelpe deg mest er Auto-Link-utvidelsen. Det oppretter en lenke på egen hånd når du bruker den på github.
Andre er tabeller og oppgavelisteelementer. Disse er praktiske for å holde rede på oppgavene dine i prosjekter. Den siste å nevne er den ikke tillatte rå HTML -utvidelsen. Ved hjelp av denne utvidelsen blir noen tagger filtrert når du gjengir for HTML. Disse taggene kan forårsake rare effekter når du gjengir GitHub.
Måter å utforske GitHub Markdown
Hvis du synes det er forvirrende, kan du også gå til GitHub-siden og bruke den innebygde redigereren. Når du bruker den, vil den automatisk fullføre noen funksjoner. Dette fungerer bare for problemer, men du kan bruke det til å finne ut av noen ting, emojiene kommer ut som en liste når du skriver en kolon (:).
Du kan også finne et prosjekt på GitHub som har flott readme -fil og kloner den til din lokale stasjon. Derfra kan du utforske filen ved hjelp av hvilken som helst redigering du ønsker. For de store redaktørene, Emacs og Vim er det støtte for markdown gjennom utvidelser.
Hvis du bruker VIM, kan du legge inn en syntaks som fremhever utvidelse fra Github, Vim-Markdown. Denne utvidelsen viser deg at du har gjort koden riktig. For å hjelpe deg med å se hvordan det ser ut når du er ferdig, kan du også få Live Mark Extension. Med dette kan du ha en webserver som kjører, og viser resultatet live mens du skriver.
Med Emacs har du utålmodig-modus, live-modus og Realtime-Preview. De viser alle din resulterende side i en nettleser mens du skriver. Den første krever mindre biblioteker enn sistnevnte, men trenger en ekstra kode-snippet for å kjøre.
Konklusjon
Selv om Markdown er en liten og bevisst enkel spesifikasjon, kan det være litt forvirrende å komme i gang med. Den beste måten å lære er å bruke et jukseark og skrive markdokumentet ditt. Du kan oppdatere readme.MD på Github, og du kan få mye støtte fra redaktørenes innebygde funksjoner. Som en sideanmerkning støtter GitHub også emojier som du kan legge til i dokumentet. Du kan bruke juksearket for å finne hvilke de er.
Last ned Markdown-cheatsheethere