DokumentációDocumentationMdxCode

Kód

Kódok használatának elsajátítása az MDX fájlokban

Forrás

Az opendocs a rehype-pretty-code könyvtárat használja az MDX fájlokban található kódok kezelésére. Ez lehetővé teszi, hogy nagymértékben testreszabd a kódok megjelenését!

További információért nézd meg a hivatalos dokumentációt és példákat!

Címek

Példa:

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

Kód:

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

Kódkiemelés

Példa:

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))",
      },
    },
  },
}
```

Beágyazott kód kiemelése

Példa:

A [1, 2, 3].join('-') eredménye '1-2-3'.

Kód:

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

Kontextusfüggő beágyazott kódkiemelés

Például ha a következő kódblokkod lenne:

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

Amikor a getStringLength elemre függvényként hivatkozunk, ennek megfelelően színezhetjük. Ugyanez igaz a function elemre, vagy a str és str közötti különbségre stb. Ez lehetővé teszi, hogy szemantikusan összekapcsoljuk a beágyazott kódot a legközelebbi kódblokkal, amelyre hivatkozik.

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.

Szókiemelés

Példa:

relative w-full pl-12 rounded-lg border

Kód:

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

Sorkiemelés

Példa:

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))",
      },
    },
  },
}
```

Sorszámozás

Példa:

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élda:

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 kiemelés

Példa:

  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

Beágyazott 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}`

Szócsoport-kiemelés azonosító alapján

Tegyél egy azonosítót a # után, a szavak után. Ez lehetővé teszi, hogy a karaktereket eltérően színezd a megadott azonosító alapján.

Példa:

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");
```

Stílusok módosításához vagy újak hozzáadásához:

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