Markdown
사투리 / 풍미

비고

스택 오버플로 마크 다운

스택 오버플로 및 다른 스택 교환 사이트에서 사용되는 태그 다운의 특징입니다. 질문에 답하거나 문서를 추가 할 때이 마크 다운을 사용합니다. 이 답변은 SO markdown에서 만들어진 것입니다.

공식 문서 보기

SO 마크 다운이 추가하는 주요 사항은 해당 웹 페이지의 "스택 교환 추가 사항"입니다. 특히, 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 은 Markdown 사용을 지원하는 일반적으로 사용되는 코드 문서 도구 (C ++, C # 및 Java를 포함한 언어 용)입니다. 표준 Markdown 구문 외에도 Doxygen 관련 요소가 많이 있습니다.

주요 기능은 참조에 @ref 태그를 사용하고, 참조 할 수있는 @page , @section/@subsection 및 @anchor 요소를 사용하는 것입니다.

@ref <name> [ "text"]

이 요소는 문서의 다른 곳에서 정의 된 명명 된 섹션, 하위 섹션, 페이지 또는 앵커에 대한 링크 (즉, 참조)를 만듭니다. ( Doxygen 참조 )

첫 번째 매개 변수 ( name )는 연결할 섹션, 하위 섹션, 페이지 또는 앵커의 이름과 일치해야합니다.

두 번째 선택적 매개 변수 ( "text" )는 큰 따옴표로 묶어야하며 페이지에 참조 링크가 표시 될 내용을 정의합니다. 사용하지 않으면 링크가 참조에 사용 된 제목으로 나타납니다.

@section <section-name> (섹션 제목)

이 요소는 섹션 이름을 정의합니다. Markdown의 # 요소와 시각적으로 동일하지만 설명서의 다른 섹션에서 연결할 수있는 참조를 정의합니다. ( Doxygen 참조 )

첫 번째 매개 변수 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.

산출

소개

이것은 내 소개의 일부 텍스트입니다.

본문 단락

이것은 내 몸의 일부 텍스트로, 소개를 참조합니다.

주의 : 위의 소개라는 단어는 소개 머리글로 이동하는 링크로 나타납니다.

GitHub 맛의 마크 다운

GitHub Flavored Markdown (때로는 GFM으로 약칭 함)을 사용하면 GitHub.com 에서 markdown을 사용하는 것이 더 쉬워집니다.

GFM의 주요 기능은 다음과 같습니다.

• 코드 들여 쓰기
• 작업 목록 지원
• 쉬운 GitHub 문제 참조
• 자동 GitHub 사용자 이름 및 SHA 탐지
• 자동 URL 감지
• 그림 이모티콘

GFM 예제

구문 강조

Markdown을 사용하면 세 개의 백틱으로 코드 블록을 생성 할 수 있습니다.

```

구문 강조 표시가 없으면 C로 작성된 코드가 다음과 같이 나타납니다.

#include <stdio.h>

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

그러나, 구문 강조와 함께, C로 작성된 코드는 다음과 같이 나타납니다 :

코드를 강조 표시하려면 선택적 언어 식별자를 추가하여 분리 기호 블록에서 구문 강조 표시를 사용하십시오.

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

이러한 향상된 기능에 포함 된 문서와 대화의 품질을 개선하도록 설계된 README 파일, 기 스트를 , 요청 당기 및 문제 플랫폼에 있습니다.