DokumentaceDocumentationMdxCode

Kód

Zvládnutí kódu v souborech MDX

Zdroj

opendocs používá knihovnu rehype-pretty-code ke zpracování kódu v souborech MDX. Díky tomu můžete výrazně přizpůsobit způsob, jakým se kód zobrazuje!

Další informace najdete v oficiální dokumentaci a příkladech.

Nadpisy

Příklad:

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

Kód:

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

Zvýraznění kódu

Příklad:

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

Kód:

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

Zvýraznění inline kódu

Příklad:

Výsledek [1, 2, 3].join('-') je '1-2-3'.

Kód:

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

Kontextové zvýraznění inline kódu

Například pokud máte následující blok kódu:

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

Když o getStringLength mluvíme jako o funkci, můžeme ji tak i barevně označit. Stejně tak function nebo str oproti str atd. To umožňuje sémanticky propojit inline kód s nejbližším blokem kódu, na který odkazuje.

Kód:

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.

Zvýraznění slov

Příklad:

relative w-full pl-12 rounded-lg border

Kód:

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

Zvýraznění řádků

Příklad:

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

Kód:

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

Číslování řádků

Příklad:

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

Kód:

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

Diff

Příklad:

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

Kód:

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

ANSI zvýraznění

Příklad:

  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/

Kód:

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

Zvýraznění skupin slov podle id

Za slova vložte id za znak #. To umožňuje obarvit znaky odlišně podle zadaného id.

Příklad:

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

Kód:

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

Jak změnit nebo přidat nové styly:

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