Markdown
Диалекты / Ароматизаторы

замечания

Устранение переполнения стека

Это аромат уценки, который используется Stack Overflow и другими сайтами обмена Stack. Когда вы отвечаете на вопрос или добавляете документацию, вы используете эту уценку. Этот ответ сделан из указателя SO

См. Официальную документацию

Главные вещи, которые добавляет SO markdown, находятся в разделе «Добавления стека Exchange» на этой веб-странице. В частности, SO добавляет теги, такие как [tag:tag] и ярлыки, такие как [meta] (не в документах), спойлеры :

Это спойлер

>! This is a spoiler

и индивидуальные языковые преданности

<!-- language: java -->
```
This text is formatted as if it were Java code
```

This text is formatted as if it were Java code

Doxygen Markdown

Doxygen - это обычно используемый инструмент для документирования кода (для языков, включая C ++, C # и Java), который также поддерживает использование Markdown. Помимо стандартного синтаксиса Markdown, существует ряд элементов, специфичных для Doxygen .

Основными функциями являются использование тегов @ref для ссылок и @page , @section/@subsection и @anchor которые они могут ссылаться.

@ref <name> ["text"]

Этот элемент создает ссылку (то есть ссылку) на именованный раздел, подраздел, страницу или привязку, которые были определены в другом месте документации. (см. ссылку на Doxygen )

Первый параметр ( name ) должен соответствовать имени раздела, подраздела, страницы или привязки, к которым вы хотите привязать.

Второй необязательный параметр ( "text" ) должен быть заключен в двойные кавычки и будет определять, какая ссылка будет отображаться на странице. Если не используется, ссылка будет отображаться как заголовок, используемый в ссылке.

@section <имя-раздела> (название раздела)

Этот элемент определяет имя раздела. Он визуально эквивалентен элементу # в Markdown, однако он также определит ссылку, которая может быть связана с другими разделами вашей документации. (см. ссылку на Doxygen )

Первый параметр section-name определяет section-name ссылки, которое может использоваться элементом @ref . Это не может содержать пробелов.

Второй section title параметра - это строка слов (которая может быть разделена пробелами), которая определяет, как заголовок раздела появится на вашей странице.

пример

@section Intro Introduction

This is some text in my introduction.

@section Body Body Paragraph

This is some text in my body, where I refer to the @ref Intro.

Выход

Вступление

Это текст в моем вступительном слове.

Пункт органа

Это текст в моем теле, где я ссылаюсь на введение.

NB: Слово Введение выше появится как ссылка, которая перейдет к заголовку Введение.

GitHub Flavored Markdown

GitHub Flavored Markdown (иногда сокращенно до GFM) упрощает работу с уценкой на GitHub.com .

К основным функциям GFM относятся:

• отступ кода
• поддержка списка задач
• простое решение проблемы GitHub
• автоматическое имя пользователя GitHub и обнаружение SHA
• автоматическое обнаружение URL-адресов
• поддержка emoji

Примеры GFM

Подсветка синтаксиса

С Markdown блок кода может быть сгенерирован с тремя backticks:

```

Без подсветки синтаксиса код, написанный на C, выглядит следующим образом:

#include <stdio.h>

int main(void)
{
    printf("Hello World\n");
    return (0);
}

Однако с подсветкой синтаксиса код, написанный на C, выглядит следующим образом:

Чтобы выделить код, просто добавьте необязательный идентификатор языка, чтобы включить подсветку синтаксиса в вашем защищенном блоке кода.

```C
<code text here>
```

Эти усовершенствования предназначены для улучшения качества документации и разговора, включенных в файлы README , gists , запросы на загрузку и проблемы на платформе.