[erlang-questions 25] edown update 2 - generates top-level README

Ulf Wiger <>
Sat Mar 26 15:35:18 CET 2011

My last post apparently triggered some people to start using edown, or at least contact me with bug reports. 

Thank you for that. :)

I have updated edown to include R14B02 additions, and corrected some layout bugs (thanks Steve V. for your patience). 

I have now added a edown-specific option, 'top_level_readme', which rewrites the hyperlinks in doc/README.md and puts the result in the top-level directory.

This way, you can maintain the overview.edoc file and have edown automatically produce a README.md for your github repos.

Details at https://github.com/esl/edown

Ulf W

PS As suggested by Paolo Negri (@hungryblank), I have also started tagging some of the commits of edown and gproc (will do so for other repos as well, in good time). The latest edown tag is 'v0.2.0'.

On 23 Mar 2011, at 08:49, Ulf Wiger wrote:

> I recently pushed a nice little contribution to edown, called markedoc.
> http://github.com/esl/edown
> Edown renders Edoc markup as Markdown, in order to make the docs easy
> to read while browsing a Github repository.
> The easiest way to use it is with rebar, 
> {deps, [{edown, ".*", {git, "git://github.com/esl/edown.git", "HEAD"}}]}.
> {edoc_opts, [{doclet, edown_doclet},
> 	     {src_path, ["src/"]},
> 	     {subpackages, true}]}.
> then ./rebar doc will generate .md files, including a doc/README.md
> Copying doc/README.md to the parent directory will break links in the module
> index. These can be manually fixed, or you can try to automate it using something
> like https://github.com/esl/run_eqc/blob/master/mk_readme.escript
> (I'm working on making that more generic, but that seems to be quite a step
> up in complexity).
> MarkEdoc goes the other way, converting Markdown to Edoc markup.
> The main use would be to maintain the README.md file as regular Markdown,
> and convert it to a proper overview.edoc using MarkEdoc.
> https://github.com/esl/edown/blob/master/bin/MARKEDOC-README.md
> Many thanks to Henning Dietrich for this contribution.
> BR,
> Ulf W
> Ulf Wiger, CTO, Erlang Solutions, Ltd.
> http://erlang-solutions.com

Ulf Wiger, CTO, Erlang Solutions, Ltd.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20110326/ce1b40b6/attachment.html>

More information about the erlang-questions mailing list