Код в Markdown

Это руководство охватывает использование инлайн кода, блоков кода, синтаксическую подсветку, подсветку строк, а также особые обозначения для ошибок и предупреждений в коде.

Инлайн-код

Инлайн-код используется для выделения коротких фрагментов кода или команд внутри текста.

Как использовать инлайн-код

Чтобы добавить инлайн-код, оберните текст в обратные кавычки (`). Например:

Используйте `cd` для смены директории.

Получим: Используйте cd для смены директории.

Блоки кода

Блоки кода используются для вставки многострочных фрагментов кода и обеспечивают читаемость для более длинных и сложных примеров.

Создание блока кода

Чтобы создать блок кода, оберните ваш код в тройные обратные кавычки (```) и укажите язык для синтаксической подсветки.

Пример блока кода

```javascript
console.log("Hello, World!");
```

Получим:

console.log("Hello, World!");

Подсветка строк в блоках кода

Подсветка строк помогает акцентировать внимание на определенных строках кода.

Способ 1: Использование hl_lines

Вы можете использовать параметр hl_lines в блоке кода для указания строк, которые хотите подсветить.

```python hl_lines="3,5"
def example_function():
    print("Эта строка не будет подсвечена")
    print("Эта строка будет подсвечена")
    print("Эта строка не будет подсвечена")
    print("Эта строка будет подсвечена")
```

Получим:

def example_function():
    print("Эта строка не будет подсвечена")
    print("Эта строка будет подсвечена")
    print("Эта строка не будет подсвечена")
    print("Эта строка будет подсвечена")

Способ 2: Указание строк и диапазонов

Вы можете указать одну строку, несколько строк, диапазоны строк или их комбинации, используя специальный синтаксис в блоке кода.

Пример подсветки одной строки

```javascript{2}
function greet() {
    console.log("Hello, World!"); // Эта строка будет подсвечена
}
```

Получим:

function greet() {
    console.log("Hello, World!"); // Эта строка будет подсвечена
}

Пример подсветки диапазона строк

```javascript{2-3}
function greet() {
    console.log("Hello, World!");
    console.log("IT wiki ru - топ");
}
```

Получим:

function greet() {
    console.log("Hello, World!");
    console.log("IT wiki ru - топ");
}

Ошибки и предупреждения в блоках кода

Вы можете выделить строки кода, содержащие ошибки или предупреждения, используя специальные комментарии.

Пример использования комментариев для ошибок и предупреждений

```javascript
export default {
data () {
    return {
    msg: 'Error', // [!code error]
    msg: 'Warning' // [!code warning]
    }
}
}
```

Получим:

export default {
  data () {
    return {
      msg: 'Error', 
      msg: 'Warning'
    }
  }
}

Группы кода

Группы кода позволяют объединять несколько блоков кода под одним заголовком или вкладками.

Пример группировки блоков кода

::: code-group

```js [config.js]
const config = {
// ...
}
export default config
```

```ts [config.ts]
const config: UserConfig = {
// ...
}
export default config
```
:::

Получим:

config.js

const config = {
  // ...
}
export default config

config.ts

const config: UserConfig = {
  // ...
}
export default config

Заключение

Использование кода в Markdown значительно улучшает восприятие технических документов, учебных материалов и статей. Правильное применение инлайн кода, блоков кода, подсветки строк, а также специальных обозначений для ошибок и предупреждений делает информацию более доступной и понятной для читателей. Группировка кода улучшает структуру документов и облегчает сравнение различных фрагментов кода или конфигураций.

Помните о следующих ключевых моментах при работе с кодом в Markdown:

• Инлайн-код идеален для коротких фрагментов кода и терминов внутри текста.
• Блоки кода обеспечивают читаемость для более длинных и сложных примеров кода.
• Подсветка строк помогает акцентировать внимание на ключевых частях кода.
• Ошибки и предупреждения в коде могут быть выделены для привлечения внимания к проблемным участкам.
• Группы кода полезны для сравнения различных версий кода или языков программирования.