<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><div><br></div><div>My last post apparently triggered some people to start using edown, or at least contact me with bug reports. </div><div><br></div><div>Thank you for that. :)</div><div><br></div><div>I have updated edown to include R14B02 additions, and corrected some layout bugs (thanks Steve V. for your patience). </div><div><br></div><div>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.</div><div><br></div><div>This way, you can maintain the overview.edoc file and have edown automatically produce a README.md for your github repos.</div><div><br></div><div>Details at <a href="https://github.com/esl/edown">https://github.com/esl/edown</a></div><div><br></div><div>BR,</div><div>Ulf W</div><div><br></div><div>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'.</div><div><br></div><br><div><div>On 23 Mar 2011, at 08:49, Ulf Wiger wrote:</div><br class="Apple-interchange-newline"><blockquote type="cite"><div><br>I recently pushed a nice little contribution to edown, called markedoc.<br><br><a href="http://github.com/esl/edown">http://github.com/esl/edown</a><br><br>Edown renders Edoc markup as Markdown, in order to make the docs easy<br>to read while browsing a Github repository.<br><br>The easiest way to use it is with rebar, <br><br>{deps, [{edown, ".*", {git, "git://github.com/esl/edown.git", "HEAD"}}]}.<br>{edoc_opts, [{doclet, edown_doclet},<br><span class="Apple-tab-span" style="white-space:pre"> </span> {src_path, ["src/"]},<br><span class="Apple-tab-span" style="white-space:pre"> </span> {subpackages, true}]}.<br><br>then ./rebar doc will generate .md files, including a doc/README.md<br>Copying doc/README.md to the parent directory will break links in the module<br>index. These can be manually fixed, or you can try to automate it using something<br>like https://github.com/esl/run_eqc/blob/master/mk_readme.escript<br>(I'm working on making that more generic, but that seems to be quite a step<br>up in complexity).<br><br>MarkEdoc goes the other way, converting Markdown to Edoc markup.<br>The main use would be to maintain the README.md file as regular Markdown,<br>and convert it to a proper overview.edoc using MarkEdoc.<br><br>https://github.com/esl/edown/blob/master/bin/MARKEDOC-README.md<br><br>Many thanks to Henning Dietrich for this contribution.<br><br>BR,<br>Ulf W<br><br><br>Ulf Wiger, CTO, Erlang Solutions, Ltd.<br>http://erlang-solutions.com<br><br><br><br></div></blockquote></div><br><div>
<div>Ulf Wiger, CTO, Erlang Solutions, Ltd.</div><div><a href="http://erlang-solutions.com">http://erlang-solutions.com</a></div><div><br></div><br class="Apple-interchange-newline">
</div>
<br></body></html>