more context-sensitive markup

doc/README.md

@@ -1,16 +1,20 @@
 
 
-#The edown application#
+<h1>The edown application</h1>
+
 The edown application
 =====================
 
 Status:
 ------
 More-or-less readable Markdown can be generated.
+
 Copyright © 2010 Erlang Solutions Ltd
 
+
 __Authors:__ [`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erlang-solutions.com).
 
+
 Status:
 ------
 More-or-less readable Markdown can be generated.
@@ -20,6 +24,7 @@ edoc_doclet creates an index.html and overview.html,
 which do not point to the .md files.
 
 
+
 To generate markdown edoc, run:
 
 
@@ -29,13 +34,15 @@ edoc:application(App, [{doclet, edown_doclet} | OtherOpts]).
 
 
 
+
 The `edown_xmerl` module is used as an xmerl export module.
 It converts xmerl's "simple xml" to Markdown syntax. Note that
 GH-flavored Markdown allows HTML markup (at least common tags),
 but doesn't expand markdown markup inside HTML markup, so the 
 `edown_xmerl` module has to know the context in which it operates.
 
 
+
 NOTE
 ====
 EDoc provides a plugin structure, so that one may specify own 
@@ -55,10 +62,13 @@ than complying fully with the plugin framework. That is, the
 edown_doclet module will not go out of its way to function together
 with any other layout module than edown_layout, and vice versa.
 
-##Modules##
+<h2 class="indextitle">Modules</h2>
+
+
 
 <table width="100%" border="0" summary="list of modules">
 <tr><td><a href="edown_doclet.md" class="module">edown_doclet</a></td></tr>
 <tr><td><a href="edown_layout.md" class="module">edown_layout</a></td></tr>
 <tr><td><a href="edown_lib.md" class="module">edown_lib</a></td></tr>
 <tr><td><a href="edown_xmerl.md" class="module">edown_xmerl</a></td></tr></table>
+

doc/edown_doclet.md

@@ -2,38 +2,53 @@ Module edown_doclet
 ===================
 
 
-#Module edown_doclet#
+<h1>Module edown_doclet</h1>
+
 * [Description](#description)
 * [Function Index](#index)
 * [Function Details](#functions)
 EDoc Doclet module for producing Github-flavored Markdown.
+
 Copyright © 2010 Erlang Solutions Ltd
+
 __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erlang-solutions.com)).
 
-##<a name="description">Description</a>##
+<h2><a name="description">Description</a></h2>
+
 EDoc Doclet module for producing Github-flavored Markdown.
 
-##<a name="index">Function Index</a>##
+<h2><a name="index">Function Index</a></h2>
+
+
 
 <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#run-2">run/2</a></td><td>Main doclet entry point.</td></tr></table>
 
+
 <a name="functions"></a>
 
 
-##Function Details##
+<h2>Function Details</h2>
+
 
 <a name="run-2"></a>
 
 
-###run/2##
+<h3>run/2</h3>
+
+
+
+
+
+<tt>run(Command::<a href="#type-doclet_gen">doclet_gen()</a> | <a href="#type-doclet_toc">doclet_toc()</a>, Ctxt::<a href="#type-edoc_context">edoc_context()</a>) -> ok</tt>
+
 
 
-`run(Command::[doclet_gen()](#type-doclet_gen) | [doclet_toc()](#type-doclet_toc), Ctxt::[edoc_context()](#type-edoc_context)) -> ok`
 
 
 Main doclet entry point.
 
 
+
 Also see [`edoc:layout/2`](edoc.html#layout-2) for layout-related options, and
   [`edoc:get_doc/2`](edoc.html#get_doc-2) for options related to reading source  
 files.
@@ -42,61 +57,97 @@ files.
 
 
 
-###`{file_suffix, string()}`##
+<dt><code>{file_suffix, string()}</code>
+   </dt>
+
 
-
-Specifies the suffix used for output files. The default value is
-       `".md"`.
-
 
 
-###`{hidden, bool()}`##
+<dd>Specifies the suffix used for output files. The default value is
+       <code>".md"</code>.
+   </dd>
+
 
 
-If the value is `true`, documentation of hidden modules and
-       functions will also be included. The default value is `false`.
-
-
 
-###`{overview, [edoc:filename()](edoc.html#type-filename)}`##
+<dt><code>{hidden, bool()}</code>
+   </dt>
+
 
 
-Specifies the name of the overview-file. By default, this doclet
-       looks for a file `"overview.edoc"` in the target directory.
+
+<dd>If the value is <code>true</code>, documentation of hidden modules and
+       functions will also be included. The default value is <code>false</code>.
+   </dd>
+
+
 
+
+<dt><code>{overview, <a href="edoc.html#type-filename">edoc:filename()</a>}</code>
+   </dt>
+
+
 
 
-###`{private, bool()}`##
+<dd>Specifies the name of the overview-file. By default, this doclet
+       looks for a file <code>"overview.edoc"</code> in the target directory.
+   </dd>
+
 
 
-If the value is `true`, documentation of private modules and
-       functions will also be included. The default value is `false`.
+
+<dt><code>{private, bool()}</code>
+   </dt>
+
+
 
+
+<dd>If the value is <code>true</code>, documentation of private modules and
+       functions will also be included. The default value is <code>false</code>.
+   </dd>
+
+
 
 
-###`{stylesheet, string()}`##
+<dt><code>{stylesheet, string()}</code>
+   </dt>
+
 
 
-Specifies the URI used for referencing the stylesheet. The
-       default value is `"stylesheet.css"`. If an empty string is
+
+<dd>Specifies the URI used for referencing the stylesheet. The
+       default value is <code>"stylesheet.css"</code>. If an empty string is
        specified, no stylesheet reference will be generated.
+   </dd>
+
+
 
-
 
-###`{stylesheet_file, [edoc:filename()](edoc.html#type-filename)}`##
+<dt><code>{stylesheet_file, <a href="edoc.html#type-filename">edoc:filename()</a>}</code>
+   </dt>
+
 
 
-Specifies the name of the stylesheet file. By default, this
-       doclet uses the file `"stylesheet.css"` in the `priv`
+
+<dd>Specifies the name of the stylesheet file. By default, this
+       doclet uses the file <code>"stylesheet.css"</code> in the <code>priv</code>
        subdirectory of the EDoc installation directory. The named file
        will be copied to the target directory.
-
-
+   </dd>
 
-###`{title, string()}`##
 
 
-Specifies the title of the overview-page.
+
+<dt><code>{title, string()}</code>
+   </dt>
+
+
 
+
+<dd>Specifies the title of the overview-page.
+   </dd>
+
+
 
-_Generated by EDoc, Oct 23 2010, 20:51:59._
+
+_Generated by EDoc, Oct 25 2010, 17:08:25._