Back to the extension listing.

Webgen::ContentProcessor::Kramdown

Summary

As short name for the content processor (used, for example, in the pipeline option of a block in a file in Webgen Page Format) one of the following can be used: markdown, kramdown.

Description

This processor converts the content, which is assumed to be in kramdown format, to HTML by using the kramdown library. The kramdown format is basically Markdown with some extensions like automatic header ID generation, using markup inside HTML elements and some more. There are a quick reference and a detailed syntax documentation available on the kramdown homepage.

One can customize how this processor works by using the following configuration options:

  • contentprocessor.kramdown.handle_links: If true (the default), then all link URLs created via kramdown syntax are automatically run through the relocatable tag. This avoids using the relocatable tag explicitly but ensures valid links nonetheless.

  • contentprocesoor.kramdown.options: This configuration option can be used to customize the kramdown processor. Have a look at the kramdown homepage for available options.

kramdown is the default markup content processor for webgen as its markup syntax is easy to learn and nice to look at. Give it a try!

Example

Here is a short sample of a text in kramdown markup:

# This a h1 header
{:#myid}

You can just write *your* paragraphs here and
[link][1] them below. This is **nice** format!

> Citations are easy too.
> Really. And you can assign them attributes.
{:.information}

* Lists
* aren't
* difficult
* either.

[1]: http://someurl.com

Back to the extension listing.