2009-09-15 5 views
0

많은 Github 프로젝트에서 Markdown을 사용하고 있습니다. 원래이 라이브러리는 사용자가 소스 코드 단편을 포함 할 수있는 설명이나 게시물을 추가 할 수있는 기능이 포함 된 StackOverflow와 같은 사이트에서만 필요하다고 생각했습니다. 그러나 일부 앱은 Markdown을 사용하지 않는 것으로 보입니다.Markdown 라이브러리를 사용해야하는지 어떻게 알 수 있습니까?

마크 다운은 원래 최대 가독성과 입력 및 출력 형태 모두의 "publishability"를 돕기 위해 존 스와 츠 그루버와 아론에 의해 생성 된 경량의 마크 업 언어이다. 이 언어는 이메일에 일반 텍스트를 표시하는 의 기존 규칙에서 많은 신호를 사용합니다. 마크 다운은 마크 업 텍스트 유효 잘 형성 XHTML로 입력 가 해당 문자 엔티티 참조 각괄호 ('<')와 앰퍼샌드 가리키는 왼쪽 변환 대체한다.

현재 사용자가 의견을 추가 할 수있는 기능이 포함 된 웹 앱을 작성하고 있습니다. 주석에 소스 코드가 포함되어 있지 않아도 Markdown을 사용해야 할 가능성이 있습니까?

답변

1

Needing Markdown은 소스 코드를 포함 할 수있는 것과 관련이 없습니다. 포맷터를 사용할 수없는 경우에도 읽을 수있는 간단한 형식으로 텍스트 서식을 지정하는 것입니다. 역사적으로, 포럼 소프트웨어는 이것을 위해 BB 코드를 사용했는데, 이는 많은 사용자들에게는 상당히 성가 시며 "읽기 쉬운"기능을 제공하지 않습니다.

어쨌든 사용자에게 질문해야하는 질문은 다음과 같습니다. 사용자가 주석의 서식을 설정하도록 하시겠습니까? 예인 경우 일부 서식 라이브러리가 필요합니다. 마크 다운은 좋은 생각 일 수 있습니다. 어쨌든 별표 또는 밑줄이있는 강조된 텍스트와 같이 텍스트 전용 환경에서 사람들이 마크 업하는 경향이 있습니다.

HTML 마크 업을 엔티티로 대체하기 때문에 기본적으로 스크립팅 공격을 방지하기 때문에 일종의 보호 기능입니다.

1

는 사용자가 굵은 또는 기울임 텍스트를 입력 할 수 있도록하려면, 또는 links to other pages을 포함 할 경우, 마크 다운 지원을 제공하는 것은 그렇게 할 수있는 좋은 방법입니다. 그것이 당신이 지원하고자하는 것이 당신에게 달려 있지만, IMO는 유용합니다.

관련 문제