Hvordan jobbe med GitHub Flavored Markdown i Linux


Markdown er et formateringsspråk som er laget for nettet. Hensikten med markdown er å gjøre livet enkelt når vi skriver på internett. Over tid er det laget mange smaker av markdown. Men i denne artikkelen vil vårt fokus hovedsakelig være på Github Flavored Markdown (GFM).

Github er basert på CommonMark. Det er mange tilleggsfunksjoner som støttes i GFM som tabeller, kodegjerder osv. La oss hoppe inn og utforske syntaksen for GFM og hvordan du bruker den i forskjellige tilfeller.

Jeg bruker VScode for å demonstrere dette, men du kan velge hvilken som helst Linux-editor som passer for deg. Noen redaktører som Atom og Vscode kommer med markdown-støtte, og for noen redaktører må vi installere en markdown-plugin.

For å jobbe med markdown bør filen lagres med .md eller .markdown som utvidelse.

Hvordan legge til overskrifter i Markdown Editor

Det er 6 overskriftsnivåer som støttes i markdown. For å lage en overskrift, bruk Hash (#)-symbolet etterfulgt av et mellomrom og navnet på overskriften. Høyere hash-verdi reduserer størrelsen på overskriften.

MERK: H1 og H2 vil ha en understrekingsstil som standard.

Heading1
## Heading2
### Heading3
#### Heading4
##### Heading5
###### Heading 6

Noen ganger vil du kanskje justere overskriften mot midten. Men den triste historien er at justering ikke støttes som standard i markdown. Som standard gjengis overskrifter med venstrejustering. Du kan bygge inn HTML/CSS-tagger i markdown for å oppnå justering.

<h1 style="text-align:center">MARKDOWN</h1>
<h1 style="text-align:left">MARKDOWN</h1>
<h1 style="text-align:right">MARKDOWN</h1>
<h1 style="text-align:justify">MARKDOWN</h1>

Hvordan legge til kommentarer til Markdown Editor

Kommentarer er en måte å dokumentere visse ting for en bedre forståelse av kode/dokumenter. Dette vil ikke bli gjengitt av markdown-motoren.

<!--
Comment block
-->

Hvordan gjengi tekst som en enkelt linje

Normalt når du skriver noe i separate linjer en etter en, vil markdown gjengi det som en enkelt linje.

Du kan lage linjeskift på to måter.

  • Mykt linjebrudd
  • Hardline brudd

Myke linjeskift kan opprettes ved å legge til to mellomrom på slutten av linjen. På denne måten vil markdown gjøre hver linje til separate linjer.

Hardelinjebrudd kan opprettes ved å sette inn en tom linje mellom hver linje.

Hvordan legge til horisontale linjer

Den horisontale regelen kan opprettes ved å plassere tre eller flere stjerner (*), bindestrek(-) eller understrek(_) på én enkelt linje. Det er også greit å legge til mellomrom mellom dem.

* * *
---
___

Hvordan lage en tekst fet

For å gjøre ord eller linjer BOLD, omslutt ordet eller linjene mellom doble stjerner (**) eller dobbel understreking (__).

**Making this sentence bold using double asterisks.**

__Making this sentence bold using double underscore.__

Hvordan lage en tekst i kursiv

For å lage ord eller linjer ITALICS, omslutt ordet eller linjene mellom enkeltstjerner (*) eller enkelt understreking (_).

*Making this line to be italicized using asterisks.*

_Making this line to be italicized using underscore._

Hvordan legge til en gjennomslag i linjer

For å slå noe må du bruke en dobbel tilde. Omring det du trenger for å slå gjennom mellom doble tilder (~~).

I am just striking the word ~~Howdy~~.

~~I am striking off the entire line.~~

Hvordan legge til et blokksitat

Bruk større enn et symbol (>) for blokkanførselstegn.

> Single line blockquote.

Se hvordan blokksitatet nedenfor gjengis. Begge linjene er gjengitt i samme linje.

> first line
> Second line
> Third line
> Fourth line

Du kan bruke linjeretur ved å la to mellomrom stå på slutten av hver linje. På denne måten vil ikke hver linje bli gjengitt på en enkelt linje.

La de alternative linjene stå tomme med prefiks med større enn et symbol. På denne måten kan du lage et linjeskift mellom hver linje innenfor samme blokk.

> first line
> 
> Second line
> 
> Third line
> 
> Fourth line 

Du kan også lage nestede blokkanførselstegn ved å legge til to større enn symboler (>>).

Opprett innebygd kode

Bruk BACKTICK for å lage innebygd kode. Eksemplet nedenfor viser hvordan du lager innebygd kode. Se på ordnotatene og readme som ble gjengitt som innebygd kode.

Markdown is one of the best tools for taking `notes` and creating `readme` files.

Legg til kodeblokksyntaksutheving

Legg til tabulatorer eller 4 mellomrom og plasser koden din for å gjengi den som en kodeblokk. Alternativt kan du plassere koden din mellom tre backticks for å få blokken til å bli gjengitt som en kodeblokk. Den viktige funksjonen å merke seg her er syntaksutheving. Normalt når du plasserer koden i blokken, er det ikke noe fargevalg brukt på den.

```
echo "Hello world"
```

Se nå på samme eksempel, fargeskjemaet brukes automatisk. Dette er mulig ved å legge til programmeringsspråknavnet etter tre bakmerker som vil bruke fargeskjemaet til koden.

```bash
echo "Hello world"
```

Eksempel på python-kode.

```python
def fp():
  print("Hello World!!!")
fp()
```

Eksempel på SQL-spørring.

```sql
SELECT MAX(SALARY_EMP) FROM EMPLOYEE_TABLE   
WHERE SALARY_EMP<(SELECT MAX(SALARY_EMP) FROM EMPLOYEE_TABLE)
```

Lag ordnede og uordnede lister

Elementer kan organiseres i ordnede lister og uordnede lister i markdown. For å lage en ordnet liste, legg til tall etterfulgt av et punktum. Den interessante delen å merke seg her er at antallet ikke trenger å være sekvensielt. Markdown-motoren er smart nok til å forstå at det er en ordnet liste selv om vi gjør den ikke-sekvensielle bestillingen.

I eksemplet nedenfor kan du se at jeg opprettet en ordnet liste med ikke-sekvensiell bestilling (10, 15, 150), men markdown-motoren gjengir den i riktig rekkefølge. Du kan også lage en nestet liste som vist på bildet.

For å lage en uordnet liste, bruk plusstegn (+) stjerner (*) eller bindestrek (-) etterfulgt av et mellomrom og innhold i listen. I likhet med den ordnede listen kan du også lage en nestet liste her.

Lag oppgaveliste

Dette er en spesiell egenskap ved GFM. Du kan lage en oppgaveliste som vist i bildet nedenfor. For å merke oppgaven som fullført, må du legge til 'x' mellom firkantede parenteser som vist på bildet.

Legg til lenker til tekst

For å legge til en lenke, følg syntaksen nedenfor.

[Tecmint](https://linux-console.net "The best site for Linux")

La oss bryte ned syntaksen i 3 deler.

  • Tekst som skal vises – Dette er teksten som vil bli plassert innenfor firkantede klammeparenteser ([Tecmint]).
  • Link – du vil plassere selve linken i parentesen.
  • Tittel – Når du holder musepekeren over teksten vil den vise et verktøytips for koblingen. Tittelen skal plasseres innenfor anførselstegn som vist på bildet.

Fra bildet nedenfor kan du se "Tecmint " er visningsteksten min, og når jeg klikker på den vil den omdirigere meg til "linux-console.net ".

Du kan også opprette lenker ved å plassere dem innenfor vinkelparenteser < >.

Legg til lenker til bilder

Syntaksen for bildet ligner på å legge til lenker. For å legge til et bilde, følg syntaksen nedenfor.

![BrokenImage](https://www.bing.com/th?id=AMMS_ff6f3f7a38b554421b6e614be6e44912&w=110&h=110&c=7&rs=1&qlt=80&pcl=f9f9f9&cdv=1&dpr=1.25&pid=16.1 "Markdown logo")

La oss bryte ned syntaksen i 3 deler.

  • Alternativ tekst – Alternativ tekst vil bli plassert mellom hakeparenteser (![alt-tekst]). Hvis et bilde er ødelagt eller ikke kan lastes vil denne teksten vises sammen med et ødelagt symbol.
  • Link – Inne i parentesene vil du plassere selve lenken til bildet.
  • Tittel – Når du holder musepekeren over bildet, vises navnet på bildet. Tittelen skal plasseres innenfor anførselstegn som vist på bildet.

Du kan også lage en lenke med bilder. Når en bruker klikker på bildet vil det bli omdirigert til en ekstern lenke. Syntaksen forblir den samme med få modifikasjoner. Omgi den samme syntaksen som vi brukte til å sette inn et bilde i hakeparenteser etterfulgt av en lenke i parentesen.

[![BrokenImage](https://www.bing.com/th?id=AMMS_ff6f3f7a38b554421b6e614be6e44912&w=110&h=110&c=7&rs=1&qlt=80&pcl=f9f9f9&cdv=1&dpr=1.25&pid=16.1 "Markdown logo")](https://en.wikipedia.org/wiki/Markdown)

Lag en tabell

Tabell støttes ikke i den opprinnelige varianten av markdown. Det er en av spesialfunksjonene som følger med GFM. La oss se hvordan du bygger et bord på en trinnvis måte.

Den første delen er å lage kolonnenavn. Kolonnenavn kan opprettes ved å skille dem med rør (|).

| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |

På den andre linjen bruker du bindestreker (-) i kombinasjon med et kolon (:). Bindestreker forteller markdown-motoren at dette skal gjengis som en tabell, og kolon bestemmer om teksten vår skal være midt-, venstre- eller høyrejustert.

| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |
|:-------------:|:-------------|------------:|

:---:  ⇒ Center alignment
:---   ⇒ Left alignment
---:   ⇒ Right alignment

Fra den tredje linjen kan du begynne å lage poster. Postene skal være atskilt med et rør (|).

| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |
|:-------------:|:-------------|------------:|
|  Ravi         |   30         |  127        |
|  karthick     |   27         |  128        |

Fra bildet ovenfor kan du se at tabellen er riktig gjengitt. Kolonne 1 er midtjustert, kolonne 2 og 3 er venstre- og høyrejustert. Hvis du bruker Vscode, kan du bruke "Markdown Table Pretifier " for å formatere tabellen pent.

Lag en Emoji

GFM støtter et bredt spekter av emojis. Ta en titt på emoji-juksearket.

Det er det for denne artikkelen. Hvis du har noen tilbakemeldinger, vennligst legg den inn i kommentarfeltet.