Документация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

Пример:

  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