Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Regenerate edocs via asciiedoc prototype

  • Loading branch information...
commit 256de0f3e00251ab959fb2270c05591bc28269a4 1 parent 290d656
@norton authored
View
98 README.md
@@ -1,97 +1,10 @@
#The asciiedoc application#
-<p>AsciiEdoc is an Erlang application that integrates AsciiDoc with EDoc
-or EDoc with EDown. This may sound a little crazy at first but the
-primary reasons are:</p>
-<ul>
-<li>
-<p>
-Dislike EDoc's primitive wiki support.
-</p>
-</li>
-<li>
-<p>
-<strong>Really</strong> dislike having to use XHTML for EDoc purposes.
-</p>
-</li>
-<li>
-<p>
-Not crazy about Markdown either. Markdown is helpful only in one
- sense - GitHub integration.
-</p>
-</li>
-<li>
-<p>
-AsciiDoc is simple, easy to use, friendly to humans, and yet
- expressive "enough" to produce high-quality documentation.
-</p>
-</li>
-</ul>
-<p>This documentation flow is a work-in-progress. There are some issues
-to investigate (e.g. duplication of overview.edoc contents) and the
-error reporting when something breaks is fragile. Nevertheless, this
-documentation flow may be of interest to others.</p>
-<p>For sample AsciiDoc-annotated overview.edoc and Erlang source files,
-see UBF and UBF-related repositories on GitHub
-(<a href="https://github.com/norton/ubf">https://github.com/norton/ubf</a>) for details.</p>
-<p><em>This repository is experimental in nature - use at your own risk and
-please contribute if you find AsciiEDoc useful.</em></p>
-<h2 id="_quick_start_recipe">Quick Start Recipe</h2>
-
-<p>To download, build, and test the asciiedoc application in one shot,
-please follow this recipe:</p>
-
-
-<pre><tt>$ mkdir working-directory-name
-$ cd working-directory-name
-$ git clone git://github.com/norton/asciiedoc.git asciiedoc
-$ cd asciiedoc
-$ ./rebar get-deps
-$ ./rebar clean
-$ ./rebar compile
-$ ./rebar doc</tt></pre>
-
-
-
-
-<h2 id="_documentation">Documentation</h2>
-
-
-<h3 id="_where_should_i_start">Where should I start?</h3>
-<p>This README is the only bit of documentation right now.</p>
-
-
-<h3 id="_what_is_edoc">What is EDoc?</h3>
-<p>EDoc is the Erlang program documentation generator. Inspired by the
-Javadoc tool for the Java programming language, EDoc is adapted to the
-conventions of the Erlang world, and has several features not found in
-Javadoc.</p>
-<p>See <a href="http://www.erlang.org/doc/apps/edoc/index.html">http://www.erlang.org/doc/apps/edoc/index.html</a> for further
-details.</p>
-
-
-<h3 id="_what_is_edown">What is EDown?</h3>
-<p>EDown is an Erlang application that generates "More-or-less readable"
-Markdown from Erlang program documentation.</p>
-<p>See <a href="https://github.com/esl/edown">https://github.com/esl/edown</a> for further details.</p>
-
-
-<h3 id="_what_is_asciidoc">What is AsciiDoc?</h3>
-<p>AsciiDoc is a text document format for writing notes, documentation,
-articles, books, ebooks, slideshows, web pages, man pages and blogs.
-AsciiDoc files can be translated to many formats including HTML, PDF,
-EPUB, man page.</p>
-<p>AsciiDoc is highly configurable: both the AsciiDoc source file syntax
-and the backend output markups (which can be almost any type of
-SGML/XML markup) can be customized and extended by the user.</p>
-<p>AsciiDoc is free software and is licenced under the terms of the <em>GNU
-General Public License version 2</em> (GPLv2).</p>
-<p>See <a href="http://www.methods.co.nz/asciidoc/index.md">http://www.methods.co.nz/asciidoc/index.html</a> for further details.</p>
+#AsciiEDoc - EDoc extension for generating HTML or Github-flavored Markdown from AsciiDoc sources#
-.
Copyright (c) 2011 by Joseph Wayne Norton
@@ -122,10 +35,9 @@ AsciiDoc is simple, easy to use, friendly to humans, and yet
</p>
</li>
</ul>
-<p>This documentation flow is a work-in-progress. There are some issues
-to investigate (e.g. duplication of overview.edoc contents) and the
-error reporting when something breaks is fragile. Nevertheless, this
-documentation flow may be of interest to others.</p>
+<p>This documentation flow is a work-in-progress and the error reporting
+is fragile when something breaks. Nevertheless, this documentation
+flow may be of interest to others.</p>
<p>For sample AsciiDoc-annotated overview.edoc and Erlang source files,
see UBF and UBF-related repositories on GitHub
(<a href="https://github.com/norton/ubf">https://github.com/norton/ubf</a>) for details.</p>
@@ -145,7 +57,7 @@ $ cd asciiedoc
$ ./rebar get-deps
$ ./rebar clean
$ ./rebar compile
-$ ./rebar doc</tt></pre>
+$ ./rebar skip_deps=true doc</tt></pre>
View
98 doc/README.md
@@ -1,97 +1,10 @@
#The asciiedoc application#
-<p>AsciiEdoc is an Erlang application that integrates AsciiDoc with EDoc
-or EDoc with EDown. This may sound a little crazy at first but the
-primary reasons are:</p>
-<ul>
-<li>
-<p>
-Dislike EDoc's primitive wiki support.
-</p>
-</li>
-<li>
-<p>
-<strong>Really</strong> dislike having to use XHTML for EDoc purposes.
-</p>
-</li>
-<li>
-<p>
-Not crazy about Markdown either. Markdown is helpful only in one
- sense - GitHub integration.
-</p>
-</li>
-<li>
-<p>
-AsciiDoc is simple, easy to use, friendly to humans, and yet
- expressive "enough" to produce high-quality documentation.
-</p>
-</li>
-</ul>
-<p>This documentation flow is a work-in-progress. There are some issues
-to investigate (e.g. duplication of overview.edoc contents) and the
-error reporting when something breaks is fragile. Nevertheless, this
-documentation flow may be of interest to others.</p>
-<p>For sample AsciiDoc-annotated overview.edoc and Erlang source files,
-see UBF and UBF-related repositories on GitHub
-(<a href="https://github.com/norton/ubf">https://github.com/norton/ubf</a>) for details.</p>
-<p><em>This repository is experimental in nature - use at your own risk and
-please contribute if you find AsciiEDoc useful.</em></p>
-<h2 id="_quick_start_recipe">Quick Start Recipe</h2>
-
-<p>To download, build, and test the asciiedoc application in one shot,
-please follow this recipe:</p>
-
-
-<pre><tt>$ mkdir working-directory-name
-$ cd working-directory-name
-$ git clone git://github.com/norton/asciiedoc.git asciiedoc
-$ cd asciiedoc
-$ ./rebar get-deps
-$ ./rebar clean
-$ ./rebar compile
-$ ./rebar doc</tt></pre>
-
-
-
-
-<h2 id="_documentation">Documentation</h2>
-
-
-<h3 id="_where_should_i_start">Where should I start?</h3>
-<p>This README is the only bit of documentation right now.</p>
-
-
-<h3 id="_what_is_edoc">What is EDoc?</h3>
-<p>EDoc is the Erlang program documentation generator. Inspired by the
-Javadoc tool for the Java programming language, EDoc is adapted to the
-conventions of the Erlang world, and has several features not found in
-Javadoc.</p>
-<p>See <a href="http://www.erlang.org/doc/apps/edoc/index.html">http://www.erlang.org/doc/apps/edoc/index.html</a> for further
-details.</p>
-
-
-<h3 id="_what_is_edown">What is EDown?</h3>
-<p>EDown is an Erlang application that generates "More-or-less readable"
-Markdown from Erlang program documentation.</p>
-<p>See <a href="https://github.com/esl/edown">https://github.com/esl/edown</a> for further details.</p>
-
-
-<h3 id="_what_is_asciidoc">What is AsciiDoc?</h3>
-<p>AsciiDoc is a text document format for writing notes, documentation,
-articles, books, ebooks, slideshows, web pages, man pages and blogs.
-AsciiDoc files can be translated to many formats including HTML, PDF,
-EPUB, man page.</p>
-<p>AsciiDoc is highly configurable: both the AsciiDoc source file syntax
-and the backend output markups (which can be almost any type of
-SGML/XML markup) can be customized and extended by the user.</p>
-<p>AsciiDoc is free software and is licenced under the terms of the <em>GNU
-General Public License version 2</em> (GPLv2).</p>
-<p>See <a href="http://www.methods.co.nz/asciidoc/index.md">http://www.methods.co.nz/asciidoc/index.html</a> for further details.</p>
+#AsciiEDoc - EDoc extension for generating HTML or Github-flavored Markdown from AsciiDoc sources#
-.
Copyright (c) 2011 by Joseph Wayne Norton
@@ -122,10 +35,9 @@ AsciiDoc is simple, easy to use, friendly to humans, and yet
</p>
</li>
</ul>
-<p>This documentation flow is a work-in-progress. There are some issues
-to investigate (e.g. duplication of overview.edoc contents) and the
-error reporting when something breaks is fragile. Nevertheless, this
-documentation flow may be of interest to others.</p>
+<p>This documentation flow is a work-in-progress and the error reporting
+is fragile when something breaks. Nevertheless, this documentation
+flow may be of interest to others.</p>
<p>For sample AsciiDoc-annotated overview.edoc and Erlang source files,
see UBF and UBF-related repositories on GitHub
(<a href="https://github.com/norton/ubf">https://github.com/norton/ubf</a>) for details.</p>
@@ -145,7 +57,7 @@ $ cd asciiedoc
$ ./rebar get-deps
$ ./rebar clean
$ ./rebar compile
-$ ./rebar doc</tt></pre>
+$ ./rebar skip_deps=true doc</tt></pre>
View
BIN  doc/erlang.png
Deleted file not rendered
View
10 doc/overview.edoc
@@ -15,10 +15,9 @@ primary reasons are:
- AsciiDoc is simple, easy to use, friendly to humans, and yet
expressive "enough" to produce high-quality documentation.
-This documentation flow is a work-in-progress. There are some issues
-to investigate (e.g. duplication of overview.edoc contents) and the
-error reporting when something breaks is fragile. Nevertheless, this
-documentation flow may be of interest to others.
+This documentation flow is a work-in-progress and the error reporting
+is fragile when something breaks. Nevertheless, this documentation
+flow may be of interest to others.
For sample AsciiDoc-annotated overview.edoc and Erlang source files,
see UBF and UBF-related repositories on GitHub
@@ -40,7 +39,7 @@ $ cd asciiedoc
$ ./rebar get-deps
$ ./rebar clean
$ ./rebar compile
-$ ./rebar doc
+$ ./rebar skip_deps=true doc
------
== Documentation
@@ -81,3 +80,4 @@ AsciiDoc is free software and is licenced under the terms of the 'GNU
General Public License version 2' (GPLv2).
See http://www.methods.co.nz/asciidoc/index.html for further details.
+@end
View
55 doc/stylesheet.css
@@ -1,55 +0,0 @@
-/* standard EDoc style sheet */
-body {
- font-family: Verdana, Arial, Helvetica, sans-serif;
- margin-left: .25in;
- margin-right: .2in;
- margin-top: 0.2in;
- margin-bottom: 0.2in;
- color: #000000;
- background-color: #ffffff;
-}
-h1,h2 {
- margin-left: -0.2in;
-}
-div.navbar {
- background-color: #add8e6;
- padding: 0.2em;
-}
-h2.indextitle {
- padding: 0.4em;
- background-color: #add8e6;
-}
-h3.function,h3.typedecl {
- background-color: #add8e6;
- padding-left: 1em;
-}
-div.spec {
- margin-left: 2em;
- background-color: #eeeeee;
-}
-a.module,a.package {
- text-decoration:none
-}
-a.module:hover,a.package:hover {
- background-color: #eeeeee;
-}
-ul.definitions {
- list-style-type: none;
-}
-ul.index {
- list-style-type: none;
- background-color: #eeeeee;
-}
-
-/*
- * Minor style tweaks
- */
-ul {
- list-style-type: square;
-}
-table {
- border-collapse: collapse;
-}
-td {
- padding: 3
-}
View
BIN  rebar
Binary file not shown
View
11 rebar.config
@@ -13,8 +13,15 @@
{erl_opts, [debug_info, warnings_as_errors
]}.
-%% Erlang edoc options
+%% Erlang edoc options for asciiedown_doclet
{edoc_opts, [{doclet, asciiedown_doclet}
- , {src_path, ["src", "test"]}
+ , {app_default, "http://www.erlang.org/doc/man"}
+ , {stylesheet, ""} % don't copy stylesheet.css
+ , {image, ""} % don't copy erlang.png
, {top_level_readme, {"./README.md", "https://github.com/norton/asciiedoc"}}
]}.
+
+%% Erlang edoc options for asciiedoc_doclet
+%% {edoc_opts, [{doclet, asciiedoc_doclet}
+%% , {app_default,"http://www.erlang.org/doc/man"}
+%% ]}.
Please sign in to comment.
Something went wrong with that request. Please try again.