DocumentazioneDocumentationMdxCode

Codice

Padroneggiare il codice nei tuoi file MDX

Sorgente

opendocs usa la libreria rehype-pretty-code per gestire il codice nei file MDX. Questo ti permette di personalizzare notevolmente il modo in cui il codice viene visualizzato.

Per maggiori informazioni, consulta la documentazione ufficiale e gli esempi.

Titoli

Esempio:

apps/web/src/index.tsx
import { App } from './App';

Codice:

```js title="apps/web/src/index.tsx"
import { App } from './App';
```

Evidenziazione del codice

Esempio:

module.exports = {
  theme: {
    extend: {
      colors: {
        warning: "hsl(var(--warning))",
        "warning-foreground": "hsl(var(--warning-foreground))",
      },
    },
  },
}

Codice:

```js
module.exports = {
  theme: {
    extend: {
      colors: {
        warning: "hsl(var(--warning))",
        "warning-foreground": "hsl(var(--warning-foreground))",
      },
    },
  },
}
```

Evidenziazione del codice inline

Esempio:

Il risultato di [1, 2, 3].join('-') è '1-2-3'.

Codice:

The result of `[1, 2, 3].join('-'){:js}` is `'1-2-3'{:js}`.

Evidenziazione del codice inline sensibile al contesto

Ad esempio, se avessi il seguente blocco di codice:

function getStringLength(str) {
  return str.length;
}

Quando ci riferiamo a getStringLength come funzione, possiamo colorarla come tale. Lo stesso vale per function, oppure str rispetto a str, ecc. Questo consente di collegare semanticamente il codice inline al blocco di codice più vicino a cui si riferisce.

Codice:

When we refer to `getStringLength{:.entity.name.function}` as a function,
we can color it as such. Same with `function{:.keyword}`, or
`str{:.variable.parameter}` vs. `str{:.variable.other.object}`, etc. This allows
semantically link inline code to the nearest block of code it refers to.

Evidenziazione delle parole

Esempio:

relative w-full pl-12 rounded-lg border

Codice:

```css /pl-12/ /border/
relative w-full pl-12 rounded-lg border
```

Evidenziazione delle righe

Esempio:

module.exports = {
  theme: {
    extend: {
      colors: {
        warning: "hsl(var(--warning))",
        "warning-foreground": "hsl(var(--warning-foreground))",
      },
    },
  },
}

Codice:

```js {2-4,6}
module.exports = {
  theme: {
    extend: {
      colors: {
        warning: "hsl(var(--warning))",
        "warning-foreground": "hsl(var(--warning-foreground))",
      },
    },
  },
}
```

Numerazione delle righe

Esempio:

module.exports = {
  theme: {
    extend: {
      colors: {
        warning: "hsl(var(--warning))",
        "warning-foreground": "hsl(var(--warning-foreground))",
      },
    },
  },
}

Codice:

```js showLineNumbers
module.exports = {
  theme: {
    extend: {
      colors: {
        warning: "hsl(var(--warning))",
        "warning-foreground": "hsl(var(--warning-foreground))",
      },
    },
  },
}
```

Diff

Esempio:

const alertVariants = cva(
- "relative w-full rounded-lg border",
+ "relative w-full pl-12 rounded-lg border"
)

Codice:

```diff
const alertVariants = cva(
- "relative w-full rounded-lg border",
+ "relative w-full pl-12 rounded-lg border"
)
```

Evidenziazione ANSI

Esempio:

  vite v5.0.0 dev server running at:
 
  > Local: http://localhost:3000/
  > Network: use `--host` to expose
 
  ready in 125ms.
 
8:38:02 PM [vite] hmr update /src/App.jsx

ANSI inline: > Local: http://localhost:3000/

Codice:

```ansi
  vite v5.0.0 dev server running at:
 
  > Local: http://localhost:3000/
  > Network: use `--host` to expose
 
  ready in 125ms.
 
8:38:02 PM [vite] hmr update /src/App.jsx
```
 
Inline ANSI: `> Local: http://localhost:3000/{:ansi}`

Evidenziazione di gruppi di parole per id

Inserisci un id dopo # dopo le parole. Questo ti permette di colorare i caratteri in modo diverso in base all'id fornito.

Esempio:

const [age, setAge] = useState(50);
const [name, setName] = useState("Taylor");

Codice:

```js /age/#v /name/#v /setAge/#s /setName/#s /50/#i /"Taylor"/#i
const [age, setAge] = useState(50);
const [name, setName] = useState("Taylor");
```

Per modificare o aggiungere nuovi stili:

apps/web/src/styles/mdx.css
[data-chars-id='v'] {
  @apply !text-pink-300 bg-rose-800/50 font-bold;
}
Adding new docsComponents