Phenquestions
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 tekstredigerer, bør du ha lett for å lese den. Dette er veldig nyttig for brukere av vim og lignende. Merk, og husk at dette er en standard for endring av tekstfiler. Det erstatter ikke HTML. I stedet bruker du den til å lage HTML der den er nyttig. I tilfelle GitHub vil de formatere Readme-filen på nettstedet. Så lenge du følger standarden, kan du føle deg sikker på at den vil se bra ut.
Siden GitHub bare har lagt til noen få utvidelser, bør du starte med å bruke et Markdown-cheatsheet og gå derfra. Her er en liste over de vanligste.
| Markdown | Utvidelser | Resultat |
| # (1 per nivå) | Overskrifter | |
| * | Kursiv | |
| ** | Dristig | |
| > | Blockquote | |
| 1. (etc.) | Bestilt liste | |
| - | Ubestilt liste | |
| 'kode' | Koden din | |
| “' | Md-ekst | 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 alle elementene du vil ha nestet.
Andre utvidelser til vanlig Markdown, du har koden blokkerer utvidelser ovenfor. De støttes ikke alltid av tjenester.
| Markdown | Utvidelser | Resultat |
| ### Overskrift # custom-id | Md-ext | En overskrift som du kan adressere med IDen |
| begrep: definisjon | Md-ext | En liste over begreper med definisjoner |
| ~ Feil tekst ~ | Md-ext | Gjennomstrekkelig tekst |
| - [x] Oppgave å gjøre | Md-ext | En oppgaveliste du kan krysse av for |
Tabellen er veldig enkel, men du trenger flere rader for å vise den: Tabell:
| Navn | VERDI || ----------- | ---------- |
| Matter | 100 |
GitHub-utvidelser.
GitHub har lagt til noen utvidelser for å gjøre det enklere å håndtere lenker til andre mennesker og prosjekter. Noen av disse er tabellene som er nevnt tidligere. Den som vil hjelpe deg mest er utvidelsen for automatisk kobling. Det oppretter en lenke alene når du bruker den på GitHub.
Andre er tabeller og oppgavelisteelementer. Disse er praktiske for å holde oversikt over oppgavene dine i prosjekter. Den siste som er nevnt er Disallowed Raw HTML-utvidelsen. Ved hjelp av denne utvidelsen blir noen tagger filtrert når de gjengis for HTML. Disse kodene kan forårsake merkelige effekter når de gjengis til 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 den til å finne ut noen ting, emojiene kommer ut som en liste når du skriver inn et kolon (:).
Du kan også finne et prosjekt på GitHub som har flott README-fil og klone det til din lokale stasjon. Derfra kan du utforske filen ved hjelp av hvilken redigerer 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 til en syntaks-uthevingsutvidelse fra GitHub, vim-markdown. Denne utvidelsen viser at du har gjort koden riktig. For å hjelpe deg med å se hvordan det ser ut når du er ferdig, kan du også få utvidelsen til live mark. Med dette kan du ha en webserver som kjører, og vise resultatet live mens du skriver.
Med Emacs har du utålmodig modus, direkte ned-modus og forhåndsvisning av sanntid. De viser alle den resulterende siden din i en nettleser mens du skriver. Den første krever færre biblioteker enn sistnevnte, men trenger en ekstra kodebit 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 Markdown-dokumentet. Du kan oppdatere README.md på GitHub, og du kan få mye støtte fra redaktørenes innebygde funksjoner. Som en sidemerknad støtter GitHub også emojis som du kan legge til i dokumentet. Du kan bruke juksearket for å finne hvilke de er.
Last ned Markdown-CheatSheet Here
