분류 php

PHP를 위한 최고의 마크 다운 라이브러리

컨텐츠 정보

  • 조회 141 (작성일 )

본문

Markdown은 매우 널리 사용되는 가벼운 마크업 언어로, 블로그의 간단한 댓글부터 블로그 게시물, 그 위에 구축 된 전체 웹 사이트에 이르기까지 다양한 응용 프로그램에서 널리 사용됩니다. 마크 업 언어의 단순성으로 인해 일반 텍스트 파일이므로 렌더링 하지 않고도 읽을 수 있으며, 그 다양성은 텍스트를 HTML, PDF, 리치 텍스트 파일 등으로 변환 할 수 있음을 의미합니다.


PHP에서 Parsedown, CommonMark, PHP Markdown 및 cebe / markdown과 같은 라이브러리는 각각 다른 구경의 기능, 성능 및 확장 성을 제공합니다. 이 기사에서는이 4 개의 라이브러리를 성능 벤치 마크와 비교하고 확장이 얼마나 쉬운 지, 그리고 이들의 다양한 기능과 특성을 비교합니다.


  • Parsedown
  • CommonMark
  • PHP MarkDown
  • cebe/markdown

원래의 Markdown 구현CommonMarkGitHub-Flavored Markdown으로 발전하여 더 나은 코드 블록, 테이블 및 원래 사양에 없는 기타 기능과 같은 기능을 제공합니다.


모든 Markdown 라이브러리가 동일한 출력을 생성하는 것은 아닙니다. 일부 라이브러리는 특정 구문 기능을 인식하지 못할 수 있으며 일부 라이브러리는 CommonMark 또는 GFM과 같은 특정 사양을 적용하지 않을 수도 있습니다. 그러나 모든 라이브러리는 최소한 John Gruber의 원래 구문과 테이블 구문 및 코드 블록 구문과 같이 가장 널리 사용되는 구문을 지원합니다.


Parsedown 


Parsedown은 Emanuil Rusev가 작성한 가장 인기 있는 PHP 용 마크 다운 라이브러리 중 하나입니다. 현재까지 13,000 개 이상의 GitHub 스타와 Packagist에서 현재까지 7 천 5 백만 개 이상의 다운로드가 있습니다. 여러 정적 CMS 소프트웨어, Laravel <6 및 Packagist에보고 된 600 개 이상의 다른 프로젝트에서 사용됩니다.


Parsedown은 대부분의 Common Mark 구문을 지원하지만 전부는 아닙니다. Markdown 구문의 가장 많이 사용되는 기능 중 일부를 고의적으로 선택하고 덜 사용되는 기능으로 확장하기 위해 자체적으로 개방하는 매우 독단적 인 라이브러리입니다.


Parsedown은 가장 간단한 구현 중 하나이며 가장 빠른 Markdown 라이브러리이기 때문에 경쟁에서 두드러집니다. 전체 Parsedown 클래스는 거의 2000 줄의 코드 (주석 및 공백 포함)로 구성된 단일 파일이며 사용하기가 매우 쉽습니다.

$parser = new Parsedown();
echo $parser->text('# Hello World!');
// "<h1>Hello World!</h1>"

Parsedown은 확장, 플러그인 또는 어떤 종류의 후크도 지원하지 않습니다. Parsedown 클래스는 Parsedown을 확장하는 자식 클래스로 확장을 위해 열려 있으며, 새로운 정규 표현식이든 추상 구문 트리에 대한 수정이든 모든 수정이 거기에서 수행 될 수 있습니다.


각주 및 정의 목록과 같은 누락 된 Markdown Extra 기능 중 일부를 지원하는 Parsedown Extra 프로젝트도 있습니다.


CommonMark 


CommonMarkColin O'Dell과 여러 기여자가 작성한 확장 성이 뛰어난 최신 마크 다운 라이브러리입니다.


CommonMark는 Laravel 6 이후 Markdown 프로세서로 선택되었으며 1,700 개 이상의 GitHub 별, Packagist에보고 된 3,100 만 이상의 다운로드, 그리고 이를 종속성으로 선언 한 250 개 이상의 프로젝트가 있습니다.


CommonMark는 완전한 CommonMark 스펙과 완전한 GitHub-Flavored Markup 스펙을 지원하여 PHP를 위한 가장 완벽한 마크 다운 라이브러리입니다.

$parser = new \League\CommonMark\CommonMarkConverter();
echo $parser->convertToHtml('# Hello World!');
// "<h1>Hello World!</h1>"

CommonMark 라이브러리는 원시 Markdown 텍스트를 Abstract-Syntax-Tree로 변환하는 파서와 AST를 HTML로 변환하는 렌더링 (HTML)으로 구성됩니다. 이러한 구성 요소는 필요에 맞게 교체 할 수 있으며 플러그인 지원을 통해 파서 및 렌더러를 더 높은 수준으로 수정할 수 있습니다.


league / commonmark 라이브러리는 또한 Markdown 텍스트를 변환하는 유창한 CLI 인터페이스를 제공하는 명령 줄 도구를 제공합니다.


PHP Markdown 


PHP Markdown은 2007 년에 만들어진 프로젝트로 현재까지 활발히 유지되고 있습니다. Michel Fortin이 만들었으며 3,200 개 이상의 GitHub 스타를 보유하고 있으며 Packagist에서 현재까지 2,600 만 건 이상의 보고서 다운로드가 있습니다.


PHP Markdown은 Perl (John Gruber에 의해)로 작성된 원래 Markdown 파서의 포트이며 나중에 개선 사항이 추가되었습니다.


PHP Markdown은 모든 것을 포함하는 단일 PHP 클래스를 제공하므로 Parsedown과 유사한 아키텍처를 따릅니다.


echo \Michelf\Markdown::defaultTransform('# Hello World!');
// "<h1>Hello World!</h1>"


PHP Markdown은 또한 주요 Michelf \ Markdown 클래스를 확장하는 Markdown Extra PHP 클래스 (Michelf \ MarkdownExtra)를 제공합니다. PHP Markdown 확장은 Markdown 또는 MarkdownExtra 클래스를 확장하여 수행 할 수도 있습니다.


PHP Markdown 클래스는 파싱 및 렌더링 동작을 구성하기 위해 일부 공용 속성을 노출합니다. 구성을 다른 컨텍스트에서 조정해야 하는 경우 공유 인스턴스 (예 : 종속성 주입 컨테이너)와 함께 사용하는 것은 직관적이지 않을 수 있습니다. 간단한 사용 사례의 경우 이 포함 된 패키지에서 사용자 정의의 균형을 잘 맞 춥니 다.


GitHub-Flavored Markup 사양이나 CommonMark 사양은 모두 구현되어 있지 않지만 널리 사용되는 기능을 제공합니다.


cebe/markdown 


cebe / markdown은 Carsten Brandt가 만든 Markdown 라이브러리입니다. 빠르고 확장 가능하며 PHP Markdown과 같은 프로젝트에서 사용되는 복잡한 정규식 대신 구문 분석 문자열에 의존하기 때문에 더 사용자 친화적일 수 있습니다.


cebe / markdown은 9,000 개 이상의 GitHub 스타를 보유하고 있으며 Packagist에 1,200 만 건 이상의 다운로드가보고되었으며 Yii 2를 포함한 100 개 이상의 부양 가족이 사용하고 있습니다.

$parser = new \cebe\markdown\Markdown();
echo $parser->parse('# Hello World!');
// "<h1>Hello World!</h1>"

CommonMark와 마찬가지로 cebe / markdown 라이브러리는 시스템에서 cmark와 같은 도구를 사용할 수 없는 경우에 도움이 될 수 있는 명령 줄 도구도 제공합니다.


cebe / markdown 라이브러리가 눈에 띄는 방식에서 가장 중요한 차이점 중 하나는 구문 확장을 위한 보다 다른 접근 방식을 제공한다는 것입니다.


새로운 라인 레벨 구문 기능은 하위 클래스에서 식별 *, 소비 * 및 렌더링 * 메소드를 선언하여 추가되며, 마크 다운 클래스는 각 라인에 대해 모든 식별 * 메소드를 자동으로 호출하고 소비하고 렌더링 하는 구문을 요청할 기회를 제공합니다. .


인라인 구문 기능 (예 : 강조 표시된 <mark> 태그)은 parse * 패턴을 준수하는 메서드와 DocBlock @marker 태그에 선언 된 마커로 추가 할 수 있습니다.

사용자 지정 코딩을 최소화하고 라이브러리가 제공하는 이름 지정 패턴을 사용하여 완전히 새로운 마크 다운 플레이버를 만들 수도 있습니다.


Opcache와 함께 cebe/markdown을 사용할 때 opcache.save_comments 구성 값은 기본값 1로 유지 되어야 합니다. 0으로 설정하면 Opcache는 DocBlock 주석을 제거하므로 이 라이브러리가 @marker DocBlock 태그에 액세스 할 수 없게 됩니다.


가장 인기 있는 마크 다운 라이브러리 


프로젝트에 있는 GitHub 별의 수는 종종 프로젝트의 품질이나 완성도에 대한 좋은 척도가 아닙니다. 그러나 스타 게이저 수와 다운로드 수는 프로젝트의 인기를 보여줍니다.


Chart of most popular PHP markdown processors 

Parsedown은 무려 7 천만 회 이상의 다운로드와 현재까지 13,000 개의 별표를 기록한 가장 많이 다운로드 되고 가장 많이 다운로드 된 Markdown 라이브러리입니다.

가장 빠른 Markdown 프로세서이기 때문에 그 인기는 당연합니다!


기능 비교 


기본 구문 



ParsedownCommonMarkPHP MarkDowncebe/markdown
**bold**/_italic_
# Headings
[Links](foo.com)
![Image](a.jpg)
- lists
> blockquotes
--- Line
~~strike-through~~✔ (Extension)


Code Blocks 



ParsedownCommonMarkPHP MarkDowncebe/markdown
Inline code
Indented code blocks
Fenced code blocks


Tables 



ParsedownCommonMarkPHP MarkDowncebe/markdown
Basic tables✔ (Extension)✔ (MarkdownExtra)✔ (MarkdownExtra)
Aligned tables✔ (Extension)✔ (MarkdownExtra)✔ (MarkdownExtra)


References 



ParsedownCommonMarkPHP MarkDowncebe/markdown
Footnotes✔ (ParsedownExtra)✔ (Extension)✔ (MarkdownExtra)
Definition Lists✔ (ParsedownExtra)✔ (MarkdownExtra)
Header Anchors✔ (ParsedownExtra)✔ (Extension)✔ (MarkdownExtra)✔ (MarkdownExtra)

CommonMark는 몇 가지 다른 확장을 지원하며 CommonMark 사양의 100 %를 구현하는 유일한 Markdown 라이브러리입니다.


CommonMark 기본 제공 확장 목록은 훨씬 더 많은 기능을 나열하므로 기능이 풍부한 라이브러리입니다.


가장 확장 가능한 마크 다운 라이브러리 


cebe / markdown, PHP MarkDown 및 Parsedown은 모두 확장 기능을 제공하지만 적절한 확장 시스템을 제공하는 CommonMark만큼 다재다능하지는 않습니다.


CommonMark를 사용하면 여러 내장 확장을 사용하거나 Markdown 클래스 자체를 완전히 확장하지 않고도 구문 분석 및 렌더링 기능을 제공하는 새 확장을 쉽게 추가 할 수 있습니다. 또한 CommonMark에는 임의의 파서 및 렌더링으로 "환경"을 쉽게 생성 할 수 있는 모듈 식 아키텍처가 있습니다.


CommonMark는 PHP에서 가장 확장 가능한 Markdown 라이브러리입니다.


가장 빠른 마크 다운 라이브러리 


라이브러리가 주어진 텍스트를 얼마나 빨리 처리 할 수 ​​있는지는 중요한 척도입니다. 라이브러리의 차이 (예 : 확장 성, 기능 세트 등)를 감안할 때 가장 빠른 라이브러리는 유스 케이스에 적합하지 않을 수 있으며 텍스트의 크기에 따라 차이가 뚜렷하지 않을 수도 있습니다.


다음 벤치 마크 결과는 PHP 8.0에서 가져온 것으로, 백만 번의 반복 평균을 사용합니다. 이 게시물은 기본 서식과 테이블이 포함되어 있기 때문에 테스트 텍스트로 사용됩니다. 이는 네 라이브러리 모두에서 가장 낮은 분모입니다.


PHP markdown processor benchmark 

CommonMarkcebe/markdownPHP MarkDownParsedown
0 bytes7.661 ms3.601 ms0.058 ms0.109 ms
1.5 kb16.098 ms4.971 ms0.677 ms0.724 ms
10 kb45.428 ms17.385 ms7.697 ms4.481 ms
100 kb293.355 ms123.412 ms72.246 ms35.367 ms
500 kb1,370.996 ms609.848 ms370.586 ms169.974 ms
1,000 kb2,896.651 ms1,380.247 ms867.377 ms367.227 ms

결과에서 Parsedown은 1MB의 원시 텍스트 입력으로도 매우 잘 유지됩니다. 한편 CommonMark는 더 큰 텍스트를 따라 잡기 위해 고군분투하고 있으며 추세선은 더 큰 텍스트 일수록 느려질 것임을 보여줍니다.


Parsedown은 가장 빠른 PHP 용 Markdown 라이브러리입니다.


모든 PHP Markdown 프로세서를 비교하면 Parsedown은 가장 빠른 Markdown 라이브러리이지만 CommonMark가 제공하는 확장 성과 사양 호환성을 제공하지 않습니다.


반면에 CommonMark는 확장 가능하고 모듈 식이며 최신 코드 기반이 있는 보다 완전한 Markdown 라이브러리입니다. 특히 100KB가 넘는 텍스트의 경우 가장 느리지 만 1-10KB의 작은 블로그 게시물 크기 텍스트의 경우 성능 오버 헤드가 그다지 중요하지 않을 수 있습니다.


https://php.watch/articles/php-markdown-libraries