ДокументаціяDocumentationMdxCode

Код

Опанування коду у ваших MDX файлах

Джерело

opendocs використовує бібліотеку rehype-pretty-code для обробки коду в MDX файлах. Це дає змогу значно налаштовувати спосіб відображення коду!

Щоб дізнатися більше, перегляньте офіційну документацію та приклади!

Заголовки

Приклад:

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

Код:

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

Підсвічування коду

Приклад:

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

Код:

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

Підсвічування inline code

Приклад:

Результат [1, 2, 3].join('-') — '1-2-3'.

Код:

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

Контекстне підсвічування inline code

Наприклад, якщо у вас є такий блок коду:

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

Коли ми посилаємося на getStringLength як на функцію, ми можемо забарвити його відповідно. Те саме стосується function або str проти str тощо. Це дає змогу семантично пов’язувати inline code з найближчим блоком коду, до якого він належить.

Код:

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.

Підсвічування слів

Приклад:

relative w-full pl-12 rounded-lg border

Код:

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

Підсвічування рядків

Приклад:

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

Код:

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

Нумерація рядків

Приклад:

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

Код:

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

Diff

Приклад:

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

Код:

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

ANSI Highlight

Приклад:

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

Підсвічування груп слів за id

Додайте id після # після слів. Це дає змогу забарвлювати символи по-різному залежно від заданого id.

Приклад:

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

Код:

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

Щоб змінити або додати нові стилі:

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