Examples for getting started?

[pawandubey]

Jygments seems a fine project (even though I doubt it is being actively maintained), but it lacks in documentation. Any plans to add a quick tutorial or getting started guide?

[tliron]

It's not actively maintained, but it is maintained. :)

I'll keep this issue open and try to find some time and write it properly.

For a superquick tutorial, check out the com.threecrickets.jygments.Jygments class. I think everything you need to use is there. As for creating your own lexers and grammars, that would require a more elaborate guide... I'll try to include that, too.

[paulc4]

@tliron Can I suggest you add this to the end of your project's README.md?

Running Jygments

Suppose I want to generate colorful syntax for the classic HelloWorld.java class. Make sure build is your current directory (it should be if you just built Jygments with Ant).

Here is a (long but) simple command to run the highlighter:

java -classpath distribution/content/libraries/jars/com.fasterxml.jackson/jackson-annotations/2.4.0/jackson-annotations.jar:distribution/content/libraries/jars/com.fasterxml.jackson/jackson-databind/2.4.2/jackson-databind.jar:distribution/content/libraries/jars/com.fasterxml.jackson/jackson/2.4.2/jackson.jar:distribution/content/libraries/jars/com.threecrickets.jygments/jygments/0.9.3/jygments.jar com.threecrickets.jygments.Jygments HelloWorld.java > HelloWorld.html

It reads HelloWorld.java and creates a pretty HelloWorld.html containing the same Java code in color.

And here is a HelloWorld.java for you to test with:

class HelloWorld {
  public static main(String[] args) {
        System.out.println("Hello World!");
  }
}

Please note that the colors generated by Jygments in HelloWorld.html are not the same as you see here. There are a set of styles in the generated HTML document that you can change.

You can see the languages recognized here:

• https://github.com/tliron/jygments/tree/master/components/jygments/source/com/threecrickets/jygments/contrib