Markdown Docs — Cheat Sheet

Tag: markdown, github-flavored-markdown, docs, formatting

Livello: base

TL;DR: Sintassi e convenzioni base per scrivere documentazione tecnica usando GitHub-Flavored Markdown.

Concetti chiave

Usa # per i titoli principali (solo uno per documento).

I sottotitoli usano ## (H2) o ### (H3) per sezioni strutturate.

Liste non ordinate usano - (trattino), quelle ordinate usano i numeri.

Mantenere i file concisi; un'idea per bullet (massimo 25 parole).

I blocchi di codice usano backticks (```) con il nome del linguaggio per l'highlighting.

Snippet e comandi

# Titolo Principale

## Sottotitolo

- Elemento lista
- Altro elemento

ts

// Esempio di blocco di codice in TypeScript

const hello = "world";

Da ripassare

  • [ ] Ricordarsi di chiudere sempre i blocchi di codice (code fence).

Riferimenti

  • Master Prompt Jarvis Interviews[cite: 2]

```

Jarvis Interviews
Jarvis