Syntaxe met en surbrillance le code Ruby dans le fichier RDOC?

Question

Je documente une bibliothèque Ruby que j'écris. Dans mon fichier readme.rdoc, j'inclus un exemple de l'utilisation avec un code de démo rubis.

Cependant, la documentation HTML résultante ne montre pas le code Ruby avec la syntaxe qui met en évidence, simplement en bloc de code.

Quand je regarde la source d'EG http://rdoc.rubyforge.org/readme_rdoc.html, tout ce que je vois, c'est un morceau de code rubis, tout comme je l'ai inclus dans mon Readme.rdoc. Existe-t-il une option spéciale pour passer à la commande RDOC?

Answer 1

Vous devez utiliser un modèle RDOC qui inclut la mise en évidence de la syntaxe. Il y a beaucoup de flottement sur le Web.

(Je suis d'accord avec phrogz, vous devez utiliser la cour et aussi la syntaxe de Markdown.)

Answer 2

RDOC, quelque peu naïvement, utilise la méthode ci-dessous pour déterminer si elle peut utiliser le surligneur de syntaxe.

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

Votre code ne sera donc mis en évidence que s'il contient l'une des chaînes suivantes:

• def
• classer
• module
• exiger
• =>
• { |
• faire |