Permalink
Browse files

Made it clearer that kramdown is a Markdown-superset converter

  • Loading branch information...
1 parent 7329d17 commit b4a6faa1c087d5240ac2c5a62d8931aa9f36b830 @gettalong gettalong committed Nov 28, 2009
Showing with 17 additions and 17 deletions.
  1. +1 −1 COPYING
  2. +1 −1 Rakefile
  3. +2 −2 doc/default.template
  4. +4 −3 doc/index.page
  5. +1 −1 doc/news.feed
  6. +6 −6 doc/quickref.page
  7. +2 −3 doc/tests.page
View
@@ -1,4 +1,4 @@
-kramdown - fast, pure-Ruby converter for Markdown-like markup
+kramdown - fast, pure-Ruby Markdown-superset converter
Copyright (C) 2009 Thomas Leitner <t_leitner@gmx.at>
kramdown is free software: you can redistribute it and/or modify
View
@@ -86,7 +86,7 @@ end
namespace :dev do
- SUMMARY = 'kramdown is a fast, pure-Ruby converter for Markdown-like markup.'
+ SUMMARY = 'kramdown is a fast, pure-Ruby Markdown-superset converter.'
DESCRIPTION = <<EOF
kramdown is yet-another-markdown-parser but fast, pure Ruby,
using a strict syntax definition and supporting several common extensions.
View
@@ -4,7 +4,7 @@
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="author" content="Thomas Leitner" />
<meta name="copyright" content="2009 Thomas Leitner" />
- <meta name="description" content="kramdown is a fast, pure-Ruby converter for Markdown-like markup." />
+ <meta name="description" content="kramdown is a fast, pure-Ruby Markdown-superset converter" />
<meta name="keywords" content="ruby, kramdown, markdown, text markup" />
<link href="{relocatable: default.css}" type="text/css" rel="stylesheet" media="screen,projection" />
<link href="{relocatable: news.atom}" type="application/atom+xml" rel="alternate" />
@@ -16,7 +16,7 @@
<div id="header">
- <h1 id="logo"><a href="{relocatable: /}" title="Homepage">kramdown <span class='slogan'>fast, pure-Ruby converter for Markdown-like markup.</span></a></h1>
+ <h1 id="logo"><a href="{relocatable: /}" title="Homepage">kramdown <span class='slogan'>fast, pure-Ruby Markdown-superset converter</span></a></h1>
<hr class="noscreen" />
</div>
View
@@ -73,9 +73,10 @@ and [mailing lists][ml] available if you have any questions!
## Welcome to the kramdown site
-kramdown is a *free* GPL-licensed [Ruby](http://www.ruby-lang.org) library for parsing Markdown-like
-syntax. It is completely written in Ruby, supports standard Markdown (with some minor modifications)
-and various extensions that have been made popular by the [PHP Markdown Extra] package and [Maruku].
+kramdown is a *free* GPL-licensed [Ruby](http://www.ruby-lang.org) library for parsing a superset of
+Markdown. It is completely written in Ruby, supports standard Markdown (with some minor
+modifications) and various extensions that have been made popular by the [PHP Markdown Extra]
+package and [Maruku].
It is probably the fastest pure-Ruby Markdown converter available (November 2009), being 5x faster
than [Maruku] and about 10x faster than [BlueFeather].
View
@@ -1,6 +1,6 @@
---
title: kramdown News
-description: kramdown - a fast, pure Ruby Markdown+extensions converter
+description: kramdown - a fast, pure Ruby Markdown-superset converter
site_url: http://kramdown.rubyforge.org/
author: Thomas Leitner
author_url: http://kramdown.rubyforge.org
View
@@ -5,10 +5,12 @@ sort_info: 9
---
# Quick Reference
-Below are examples of all available structural elements that can be used in kramdown text. Note,
-that only the most basic syntax information is given. However, a link to the detailed syntax for
-each element is provided. The quick reference is for version **<%= Kramdown::VERSION %>** of the
-syntax documentation.
+Below are examples of all available structural elements that can be used in a kramdown text. Since
+the kramdown syntax is a superset of the Markdown syntax, only a small part of the available syntax
+is not available in standard Markdown syntax. Note, that only the most basic syntax information is
+given. However, a link to the detailed syntax for each element is provided (which also details the
+differences to the standard Markdown syntax). The quick reference is for version **<%=
+Kramdown::VERSION %>** of the syntax documentation.
kramdown has two main classes of elements: block and span level elements. Block level elements are
used to create paragraphs, headers, lists and so on whereas span level elements are used to markup
@@ -17,7 +19,6 @@ text phrases as emphasized, as a link and so on.
All examples below feature the kramdown source, the converted HTML source and the output as it
appears in the browser. This looks like this:
-{::nomarkdown:}
<div class="kdexample">
<pre class="kdexample-before"><code>kramdown example code
</code></pre>
@@ -28,7 +29,6 @@ Live browser view of example code
</div>
</div>
<div class="clear"></div>
-{::nomarkdown:}
# Block Level Elements - Main Structural Elements
View
@@ -34,11 +34,10 @@ fast but they do not provide additional syntax elements). As one can see below,
currently (November 2009) ~5x faster than Maruku, ~10x faster than BlueFeather but ~30x slower than
BlueCloth and rdiscount:
-{::nomarkdown:}
<pre><code>
{execute_cmd: {command: "ruby -Ilib -rubygems benchmark/benchmark.rb", process_output: false, escape_html: true}}
-</code></pre>
-{::nomarkdown:}
+</code>
+</pre>
[Markdown Test Suite]: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip
[MDTest]: http://www.michelf.com/docs/projets/mdtest-1.0.zip

0 comments on commit b4a6faa

Please sign in to comment.