DokumentasjonDocumentationMdxCode

Kode

Mestre kode i MDX-filene dine.

opendocs bruker biblioteket rehype-pretty-code til å håndtere kode i MDX-filer. Dette lar deg tilpasse måten kode vises på i stor grad!

For mer informasjon kan du se den offisielle dokumentasjonen og eksemplene!

Titler

Eksempel:

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

Kode:

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

Kodeutheving

Eksempel:

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

Kode:

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

Utheving av inline-kode

Eksempel:

Resultatet av [1, 2, 3].join('-') er '1-2-3'.

Kode:

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

Kontekstbevisst utheving av inline-kode

For eksempel, hvis du hadde følgende kodeblokk:

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

Når vi omtaler getStringLength som en funksjon, kan vi fargelegge den som det. Det samme gjelder function, eller str kontra str, osv. Dette gjør det mulig å knytte inline-kode semantisk til den nærmeste kodeblokken den refererer til.

Kode:

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.

Ordutheving

Eksempel:

relative w-full pl-12 rounded-lg border

Kode:

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

Linjeutheving

Eksempel:

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

Kode:

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

Linjenummerering

Eksempel:

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

Kode:

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

Diff

Eksempel:

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

Kode:

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

ANSI-utheving

Eksempel:

  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/

Kode:

```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}`

Ordgruppeutheving etter id

Legg til en id etter # etter ordene. Dette lar deg fargelegge tegn ulikt basert på den angitte id-en.

Eksempel:

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

Kode:

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

For å endre eller legge til nye stiler:

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