Markdown API

세부정보:

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

Markdown 콘텐츠를 HTML로 변환합니다.

APIv4에서만 사용 가능합니다.

필수 인증

  • GitLab 15.3에서 도입됨 with a flag 이름이 authenticate_markdown_api인 플래그와 함께. 기본값으로 활성화되어 있습니다.

자체 관리형 GitLab에서는 기본적으로 이 기능이 활성화되어 있으며 인증이 필요합니다.
인증 요구 사항을 제거하려면 관리자가 disable the feature flag 이름이 authenticate_markdown_api인 플래그를 비활성화할 수 있습니다.
GitLab.com에서는 이 기능을 사용할 수 있습니다. GitLab Dedicated에서는 이 기능을 이용할 수 있습니다.

모든 API 호출은 authenticated해야 합니다.

임의의 Markdown 문서 렌더링 

POST /markdown
속성 유형 필수 설명
text string 예 렌더링할 Markdown 텍스트
gfm boolean 아니오 GitLab Flavored Markdown를 사용하여 텍스트를 렌더링합니다. 기본값은 false입니다.
project string 아니오 GitLab Flavored Markdown를 사용할 때 참조 생성을 위한 컨텍스트로 project를 사용합니다. 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type:application/json" \
  --data '{"text":"Hello world! :tada:", "gfm":true, "project":"group_example/project_example"}' "https://gitlab.example.com/api/v4/markdown"

응답 예시:

{ "html": "<p dir=\"auto\">Hello world! <gl-emoji title=\"party popper\" data-name=\"tada\" data-unicode-version=\"6.0\">🎉</gl-emoji></p>" }