Hvordan inkludere havfruediagrammer i GitHub-prosjektet ditt

Den populære kodedelingsplattformen, GitHub, har annonsert støtte for en ny type innebygd innhold. I markdown-filer kan du nå bruke Mermaid-syntaks til å enkelt lage flytskjemaer, sekvensdiagrammer og mer.

GitHubs smak av markdown håndterer allerede bilder, oppgavelister og emoji-kortkoder. Med støtte for vanlige diagrammer, gjør GitHub sitt for mer informativ, nyttig dokumentasjon.

Hva er nytt med GitHub?

Du kan nå bygge inn Mermaid-kode i din README.md og andre markdown-filer. Hvis du gjør det, vil GitHub gjengi et diagram beskrevet av den koden. Havfruekode bruker en enkel syntaks som beskriver de enkelte delene av hvert diagram i ren tekst.

Se også: Hva er GitHub? En introduksjon til de grunnleggende funksjonene

Hvordan inkluderer du diagrammer?

1. Velg enten en eksisterende markdown-fil eller opprett en ny for å legge til i depotet ditt. Bruk enten .md eller .markdown utvidelser.
2. Legg til en Mermaid-kode i den filen. Nøyaktig hvilken kode er opp til deg; her er et enkelt eksempel for å komme i gang:

   graf TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

instagram viewer
3. Se filen på GitHub. Du bør se en fin gjengivelse av diagrammet ditt.

Nå trenger du bare å lære rikdommen av diagrammer som Mermaid har tilgjengelig. Eller du kan ganske enkelt referere til Havfrue dokumentasjon når og når du trenger et diagram.

Hvilke typer diagrammer kan jeg bruke?

Mermaid støtter følgende typer diagrammer:

• Flytskjema
• Sekvens
• Klasse
• Stat
• Entitetsforhold
• Brukerreise
• Gantt
• Pai
• Krav

Se også: Gantt-diagram vs. PERT-diagram: Hva er forskjellene?

Hver har sin egen syntaks for å gjenspeile typen data som diagrammet viser. For eksempel, her er koden for et enkelt sekvensdiagram:

sekvensdiagram
 Bart->>Homer: Ikke ha en ku, mann.

Som ser slik ut når det gjengis:

Og her er koden for et grunnleggende tilstandsdiagram:

stateDiagram-v2
 [*] --> Ny
 Ny --> Klar: innlagt
 Klar --> Kjører: planlegger utsendelse
 Kjører --> Klar: avbryte
 Kjører --> Venter: I/O eller hendelsesvent
 Venter --> Klar: I/O eller hendelsesfullføring
 Kjører --> Avsluttet: avslutt
 Avsluttet --> [*]

Som gjengir som sådan:

Legg til verdi til GitHub-prosjektene dine med havfruediagrammer

Havfruediagrammer er et nyttig tillegg til GitHub, spesielt siden vi mener de oppmuntrer til bedre dokumentasjon. Mange prosjekter kan forbedres med noen visuelle forklaringer rett i dokumentasjonen eller README-filene.

GitHub er nå en så populær tjeneste, dens funksjoner og endringer påvirker mange utviklere rundt om i verden. Heldigvis er støtte for havfruediagrammer der hvis du trenger det, og usynlig hvis du ikke gjør det. Men forhåpentligvis vil du i det minste begynne å se litt bedre dokumentasjon.

Hvordan være vert for et nettsted gratis ved å bruke GitHub-sider

Hvis du har en enkel nettside, trenger du ikke betale for webhotell. Du kan bruke GitHub-sider gratis!

Les Neste

Om forfatteren