구문 강조 RDoc 파일의 루비 코드?

Question

내가 쓰고있는 Ruby 라이브러리에 대한 문서를 작성 중입니다. README.rdoc 파일에서 몇 가지 데모 Ruby 코드 사용 예제를 포함합니다.

그러나 결과 HTML 문서는 구문 강조 표시가있는 Ruby 코드를 단순히 코드 블록으로 표시하지 않습니다.

예를 들어 http://rdoc.rubyforge.org/README_rdoc.html, 내 README.rdoc에 포함 된 것처럼 루비 코드 조각 만 볼 수 있습니다. rdoc 명령에 전달할 특별한 옵션이 있습니까?

Answer 1

구문 강조를 포함하는 RDoc 템플릿을 사용해야합니다. 웹 주위에는 많은 것이 떠 다니고 있습니다.

(내가 Phrogz에 동의, 당신은 YARD 또한 마크 다운 문법을 사용해야합니다.)

Answer 2

RDoc이 다소 순진, 그것은 구문 하이 라이터를 사용할 수 있는지 확인하려면 아래의 방법을 사용합니다.

def parseable? text 
    text =~ /\b(def|class|module|require) |=>|\{\s?\||do \|/ and 
     text !~ /<%|%>/ 
    end 

그래서 코드는 그 다음 문자열 중 하나가 포함 된 경우 강조 표시됩니다 :

• 데프
• 클래스
• 모듈은
• 필요한
• =>
• {|
• do |