aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2012-03-07 09:08:36 -0500
committerWaylan Limberg <waylan@gmail.com>2012-03-07 09:08:36 -0500
commit9fd4a5f1600c96406ad0fb86b1a8287d525972ac (patch)
treeea8907182d758d051fce4bb54f445a113ceea92b /docs
parent9c2830f7b0273ae399b771a7d9780ee7a7430fc4 (diff)
downloadmarkdown-9fd4a5f1600c96406ad0fb86b1a8287d525972ac.tar.gz
markdown-9fd4a5f1600c96406ad0fb86b1a8287d525972ac.tar.bz2
markdown-9fd4a5f1600c96406ad0fb86b1a8287d525972ac.zip
Fixed up some formating errors in docs and added/fixed more internal links.
Diffstat (limited to 'docs')
-rw-r--r--docs/extensions/abbreviations.md2
-rw-r--r--docs/extensions/definition_lists.md2
-rw-r--r--docs/extensions/html_tidy.md3
-rw-r--r--docs/extensions/index.md2
-rw-r--r--docs/extensions/meta_data.md2
-rw-r--r--docs/extensions/sane_lists.md2
-rw-r--r--docs/extensions/smart_strong.md7
-rw-r--r--docs/extensions/tables.md47
-rw-r--r--docs/extensions/wikilinks.md2
-rw-r--r--docs/reference.md2
10 files changed, 36 insertions, 35 deletions
diff --git a/docs/extensions/abbreviations.md b/docs/extensions/abbreviations.md
index 994d8dc..fa38f50 100644
--- a/docs/extensions/abbreviations.md
+++ b/docs/extensions/abbreviations.md
@@ -5,7 +5,7 @@ next_title: Attribute List Extension
next_url: attr_list.html
Abbreviations
--------------
+=============
Summary
-------
diff --git a/docs/extensions/definition_lists.md b/docs/extensions/definition_lists.md
index a76be5c..53f14a0 100644
--- a/docs/extensions/definition_lists.md
+++ b/docs/extensions/definition_lists.md
@@ -5,7 +5,7 @@ next_title: Fenced Code Block Extension
next_url: fenced_code_blocks.html
Definition Lists
-----------------
+================
Summary
-------
diff --git a/docs/extensions/html_tidy.md b/docs/extensions/html_tidy.md
index db807f7..391349b 100644
--- a/docs/extensions/html_tidy.md
+++ b/docs/extensions/html_tidy.md
@@ -15,7 +15,7 @@ This extension is available in the standard Markdown library since version 2.0.
[HTML Tidy]: http://tidy.sourceforge.net/
[uTidylib]: http://utidylib.berlios.de/
-Note than any Tidy [options][] can be passed in as extension configs. So,
+Note than any Tidy [options][] can be passed in as [extension configs][]. So,
for example, to output HTML rather than XHTML, set ``output_xhtml=0``. To
indent the output, set ``indent=auto`` and to have Tidy wrap the output in
``<html>`` and ``<body>`` tags, set ``show_body_only=0``. See Tidy's
@@ -24,6 +24,7 @@ most closely match Markdowns defaults with the exception that you get much
better pretty-printing.
[options]: http://tidy.sourceforge.net/docs/quickref.html
+[extension configs]: ../reference.html#extension_configs
Note that options set in this extension will override most any other settings
passed on to Markdown (such as "output_format"). Unlike Markdown, this extension
diff --git a/docs/extensions/index.md b/docs/extensions/index.md
index 293d1b0..82b0eda 100644
--- a/docs/extensions/index.md
+++ b/docs/extensions/index.md
@@ -13,7 +13,7 @@ to change and/or extend the behavior of the parser without having to edit the
actual source files.
To use an extension, pass it's name to markdown with the `extensions` keyword.
-See the [Library Reference](../reference.html) for more details.
+See the [Library Reference](../reference.html#extensions) for more details.
markdown.markdown(some_text, extensions=['extra', 'nl2br'])
diff --git a/docs/extensions/meta_data.md b/docs/extensions/meta_data.md
index 8c156c9..1695d8b 100644
--- a/docs/extensions/meta_data.md
+++ b/docs/extensions/meta_data.md
@@ -87,7 +87,7 @@ Extension and the keywords they are known to support:
* [HeaderId](header_id.html)
* `header_level`
* `header_forceid`
-* [[WikiLinks](wikilinks.html)
+* [WikiLinks](wikilinks.html)
* `wiki_base_url`
* `wiki_end_url`
* `wiki_html_class`
diff --git a/docs/extensions/sane_lists.md b/docs/extensions/sane_lists.md
index c108ad8..e6c73f4 100644
--- a/docs/extensions/sane_lists.md
+++ b/docs/extensions/sane_lists.md
@@ -5,7 +5,7 @@ next_title: Table of Contents Extension
next_url: toc.html
Sane Lists
-----------
+==========
Summary
-------
diff --git a/docs/extensions/smart_strong.md b/docs/extensions/smart_strong.md
index 22468d6..8de574f 100644
--- a/docs/extensions/smart_strong.md
+++ b/docs/extensions/smart_strong.md
@@ -5,13 +5,14 @@ next_title: CodeHilite Extension
next_url: code_hilite.html
Smart_Strong
-------------
+============
Summary
+-------
The Markdown Smart_Strong Extension adds smarter handling of double underscores
-within words. This does for double underscores what 'smart_emphasis' does for
-single underscores.
+within words. This does for double underscores what
+[smart_emphasis](../reference.html#smart_emphasis) does for single underscores.
The Smart_Strong Extension is included in the standard Markdown library.
diff --git a/docs/extensions/tables.md b/docs/extensions/tables.md
index e37a752..bb0872a 100644
--- a/docs/extensions/tables.md
+++ b/docs/extensions/tables.md
@@ -5,7 +5,7 @@ next_title: Smart Strong Extension
next_url: smart_strong.html
Tables
-----------------
+======
Summary
-------
@@ -23,32 +23,31 @@ Tables are defined using the syntax established in [PHP Markdown Extra][php].
Thus, the following text (taken from the above referenced PHP documentation):
-First Header | Second Header
-------------- | -------------
-Content Cell | Content Cell
-Content Cell | Content Cell
+ First Header | Second Header
+ ------------- | -------------
+ Content Cell | Content Cell
+ Content Cell | Content Cell
will be rendered as:
-<table>
-<thead>
-<tr>
-<th>First Header</th>
-<th>Second Header</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>Content Cell</td>
-<td>Content Cell</td>
-
-</tr>
-<tr>
-<td>Content Cell</td>
-<td>Content Cell</td>
-</tr>
-</tbody>
-</table>
+ <table>
+ <thead>
+ <tr>
+ <th>First Header</th>
+ <th>Second Header</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Content Cell</td>
+ <td>Content Cell</td>
+ </tr>
+ <tr>
+ <td>Content Cell</td>
+ <td>Content Cell</td>
+ </tr>
+ </tbody>
+ </table>
Usage
-----
diff --git a/docs/extensions/wikilinks.md b/docs/extensions/wikilinks.md
index 522e7c5..b5e2b04 100644
--- a/docs/extensions/wikilinks.md
+++ b/docs/extensions/wikilinks.md
@@ -125,7 +125,7 @@ Some may prefer the more complex format when calling the `Markdown` class direct
Using with Meta-Data
--------------------
-The WikiLink Extension also supports the [Meta-Data](meta_date.html) Extension.
+The WikiLink Extension also supports the [Meta-Data](meta_data.html) Extension.
Please see the documentation for that extension for specifics. The supported
meta-data keywords are:
diff --git a/docs/reference.md b/docs/reference.md
index daf24ac..c1561f7 100644
--- a/docs/reference.md
+++ b/docs/reference.md
@@ -69,7 +69,7 @@ The following options are available on the `markdown.markdown` function:
`extensions=['extra']` will first look for the module
`markdown.extensions.extra`, then a module named `mdx_extra`.
-* __`extension-configs`__{: #extensions_configs }: A dictionary of
+* __`extension-configs`__{: #extension_configs }: A dictionary of
configuration settings for extensions.
The dictionary must be of the following format: