의견 요청 : 마크 다운에 코드 스 니펫을 포함하려면 구문은 무엇입니까? (외부 파일에서)

Question

나는 사용하고있다 가격 인하 최근에.

Markdown의 가장 큰 문제 중 하나는 Markdown이 문서 내에 파일을 포함시키는 것에 대한 구문이 없다는 것입니다 (예 : listings 라텍스 패키지).

전체 파일과 부분 파일을 코드 스 니펫으로 포함하여 Markdown을 확장하고 싶습니다. 예를 들어 다음과 같이 보일 수 있습니다.

![:include src/foo/bar.rb](10-20)

그리고 그것은 내용물을 넣을 것입니다 bar.rb 내 문서에 10-20 행 code 차단하다. 이론적 근거는 바로 그 근거입니다

• 코드가 변경됨에 따라 문서를 업데이트 할 수 있습니다. (항상 구식이되는 복사 및 붙여 넣기)
• 그런 다음 문서에있는 정확한 코드를 테스트 할 수 있습니다.

내 질문은 다음과 같습니다.

1. 구문은 무엇이어야합니까?
2. 이 작업이 이미 완료되었고 내가 놓치고 있습니까?

Answer 1

나는 Markdown 구문을 확장 한 다음 포함 기능을 지원하는 데 사용하는 일반적인 수단을 생각해내는 경향이 있습니다. 예를 들어, 구문을 다음과 같이 정의 할 수 있습니다 (실제로이 특정 구문을 제안하는 것이 아니라 예제입니다).

[[command: arg arg arg...]]

..어디 command Markdown Parser가 이해하지 못하는 명령을 말하지만 처리하기 위해 다른 것으로 다시 전화 할 수 있습니다. 그런 다음 Markdown과 함께 작동하지만 실제로는 그렇지 않은 기능을 작성할 수 있습니다. 같은 것 :

[[include: src/foo/bar.md]]

아, 그리고 당신이 이것을한다면, 나는 아마도 줄 번호를 사용하지 않는 부분 파일을 포함시키는 수단을 제공하지 않을 것입니다. 즉, 당신은 당신이 당신이 실제로 재사용이 더 어려워지는 문서 (섹션을 태그하는 방법을 제시 할 수 있다면 더 잘 작동 할 수 있습니다).

Answer 2

나는 일반적으로 기존 구문을 합리적으로 작업하기 위해 일이 만들어 질 수 있는지를 보는 경향이 있습니다. 현재

    ![Example Photo](http://example.com/example.jpg)

구문과 그 친척은 텍스트에 이미지를 포함하는 데 사용됩니다. 비슷한 맥락에서

    +[Generic Heading](http://example.com/heading.txt)

또는

    +[Local Heading](file:///dir/a/b/c/example.txt)

텍스트를 포함하는 데 사용할 수 있습니다. 이 경우 사각형 괄호의 텍스트는 alt-text 인라인 이미지의 속성 : 포함중인 파일에 대한 짧고 인간의 이해할 수있는 설명이 포함되어 있습니다.

사용 + 나에게 직관적입니다 : 그것은 의미합니다 추가하다 이 파일의 내용은 여기 에서이 문서입니다.

Answer 3

조금 늦었 어 죄송합니다. 그러나 구조 조정 텍스트는 이미 다음을 지원합니다.http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment