Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Pygments-based syntax highlighting for YARD.
Ruby
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
templates/default
.gitignore
.yardopts
MIT-LICENSE
README.md
Rakefile
VERSION
yard-pygments.gemspec

README.md

yard-pygments

This is a plugin for the YARD documentation system that adds syntax highlighting for a wide variety of languages using the Pygments syntax highlighter.

Usage

Once the gem is installed, YARD should automatically load it. Then any block of code beginning with !!!lang that YARD doesn't recognize will be highlighted using Pygments if possible. Unless another highlighter is installed, in which case it might take precedence.

By default, YARD itself only recognizes Ruby. The full list of languages recognized by Pygments is available here. The names that will be recognized for these languages are listed under "short names".

Requirements

yard-pygments requires rb-pygments, which in turn requires Pygments itself. Since Pygments is written in Python, it needs to be installed manually. If you've got easy_install, you can do

!!!sh
easy_install Pygments

Otherwise, it can be downloaded here.

Something went wrong with that request. Please try again.