org.ocpsoft.rewrite.transform.markup

Class Markdown

java.lang.Object

org.ocpsoft.rewrite.transform.StringTransformer

org.ocpsoft.rewrite.transform.markup.impl.JRubyTransformer<Markdown>

org.ocpsoft.rewrite.transform.markup.Markdown

All Implemented Interfaces:

Transformer

public class Markdown
extends JRubyTransformer<Markdown>

A Transformer that translates Markdown files into HTML.

Author:

Christian Kaltepoth

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Markdown(boolean fullDocument) Creates a Markdown instance.

Method Summary

Modifier and Type	Method and Description
Markdown	addStylesheet(String url) Adds a CSS stylesheet to the rendered HTML document.
static Markdown	fullDocument() Create a Transformer instance that renders a full markdown HTML document structure.
List<String>	getLoadPaths() Return the load paths to use for ScriptingContainer.setLoadPaths(List).
protected Class<Markdown>	getTransformerType()
static Markdown	partialDocument() Create a Transformer instance that renders markdown without adding the HTML scaffold like a body or head.
protected void	prepareContainer(org.jruby.embed.ScriptingContainer container)
Object	runScript(org.jruby.embed.ScriptingContainer container) This method must perform the transformation using the supplied ScriptingContainer.
Markdown	self() Just returns the current object as the correct type for make the fluent builder work with subclasses.
Markdown	withTitle(String title) Sets the title of the rendered HTML document.

Methods inherited from class org.ocpsoft.rewrite.transform.markup.impl.JRubyTransformer

compatVersion, compileMode, transform

Methods inherited from class org.ocpsoft.rewrite.transform.StringTransformer

transform

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Markdown

protected Markdown(boolean fullDocument)

Creates a Markdown instance.

Method Detail

fullDocument

public static Markdown fullDocument()

Create a Transformer instance that renders a full markdown HTML document structure.

partialDocument

public static Markdown partialDocument()

Create a Transformer instance that renders markdown without adding the HTML scaffold like a body or head.

withTitle

public Markdown withTitle(String title)

Sets the title of the rendered HTML document. Only applicable when rending a full document.

addStylesheet

public Markdown addStylesheet(String url)

Adds a CSS stylesheet to the rendered HTML document. Only applicable when rending a full document.

getLoadPaths

public List<String> getLoadPaths()

Description copied from class: JRubyTransformer

Return the load paths to use for ScriptingContainer.setLoadPaths(List).

Specified by:

getLoadPaths in class JRubyTransformer<Markdown>

runScript

public Object runScript(org.jruby.embed.ScriptingContainer container)

Description copied from class: JRubyTransformer

This method must perform the transformation using the supplied ScriptingContainer. The container is pre initialized with a variable input which should be used by the script to perform the transformation.

Specified by:

runScript in class JRubyTransformer<Markdown>

self

public Markdown self()

Description copied from class: JRubyTransformer

Just returns the current object as the correct type for make the fluent builder work with subclasses.

Specified by:

self in class JRubyTransformer<Markdown>

prepareContainer

protected void prepareContainer(org.jruby.embed.ScriptingContainer container)

Specified by:

prepareContainer in class JRubyTransformer<Markdown>

getTransformerType

protected Class<Markdown> getTransformerType()

Specified by:

getTransformerType in class JRubyTransformer<Markdown>