구문은 RDOC 파일의 Ruby 코드를 강조 표시 하시겠습니까?
문제
나는 쓰는 루비 라이브러리를 문서화하고 있습니다.내 readme.rdoc 파일에서 일부 데모 루비 코드가있는 사용 예제를 포함하고 있습니다.
그러나 결과 HTML 문서는 구문 강조 표시가있는 루비 코드가 단순히 코드 블록으로 표시되지 않습니다.
예를 들어 소스를 볼 때. http://rdoc.rubyforge.org/readme_rdoc.html 의 모든 것들은Ruby 코드, 제 Readme.rdoc에 포함 된 것처럼.RDOC 명령에 전달하는 특별한 옵션이 있습니까?
해결책
구문 강조 표시가 포함 된 RDOC 템플리트를 사용해야합니다.웹 주위에는 많은 사람들이 있습니다.
(Phrogz에 동의 함) 마당 및 마트 다운 구문을 사용해야합니다.)
다른 팁
RDOC, 다소 순진한 경우, 아래의 방법을 사용하여 구문 형광펜을 사용할 수 있는지 여부를 결정합니다.
def parseable? text
text =~ /\b(def|class|module|require) |=>|\{\s?\||do \|/ and
text !~ /<%|%>/
end
.
다음 문자열 중 하나가 포함되어 있으면 코드 만 강조 표시됩니다.
- def
- 클래스
- 모듈
- 는 를 필요로합니다
- =>
- {|
- do |
제휴하지 않습니다 StackOverflow