I think that Anatoly was suggestion a bridge between markdown and haddock syntax.<div><br></div><div>Of course gitit would read haddock-documented sources and generate different results than haddock itself (showing highlighted source code is the most significant).</div>
<div><br></div><div>Being practical, this is very close to the markdownish literate haskell you are suggesting.</div><div><br></div><div>hugo<br><br><div class="gmail_quote">On Thu, Dec 4, 2008 at 1:54 AM, John MacFarlane <span dir="ltr"><<a href="mailto:jgm@berkeley.edu">jgm@berkeley.edu</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">+++ Anatoly Yakovenko [Dec 03 08 17:03 ]:<br>
<div class="Ih2E3d">> This is pretty cool. I was wondering how much work would it be for<br>
> gitit to be able to use markdown from the comment sections in source<br>
> files? It would be a really good way to manage documentation.<br>
><br>
> Basically I would like to be able to point gitit at an existing git<br>
> repo, and have it provide a wiki interface to all the documentation so<br>
> developers can view and modify it.<br>
<br>
</div>You can do something like that now. You can specify the repository<br>
directory in a configuration file. Anything in the repository (even<br>
in subdirectories) with a ".page" extension will be served up as a<br>
wiki page. So you'd have to use a ".page" extension for your markdown<br>
documentation. Everything else in the repository will appear in the<br>
index. Source code files will be automatically syntax-highlighted, and<br>
you can even view history and diffs through the wiki interface.<br>
<br>
But I guess what you want is for the documentation to be in comments<br>
in the source files themselves, not in separate files. I'm not sure<br>
how to do that -- would the idea be to show just the documentation,<br>
perhaps marked off with some special notation, and not the source?<br>
But then we lose a nice feature, the ability to view source files.<br>
I'm open to ideas.<br>
<br>
Soon, gitit will contain support for pages in markdownish literate<br>
Haskell, which might be the best of both worlds for Haskell projects.<br>
(They'd still need the .page extension, since some .lhs files are<br>
LaTeX lhs, but one could use hard links, or there could be a<br>
configuration option to treat .lhs files as wiki pages.)<br>
<font color="#888888"><br>
John<br>
</font><div><div></div><div class="Wj3C7c"><br>
_______________________________________________<br>
Haskell-Cafe mailing list<br>
<a href="mailto:Haskell-Cafe@haskell.org">Haskell-Cafe@haskell.org</a><br>
<a href="http://www.haskell.org/mailman/listinfo/haskell-cafe" target="_blank">http://www.haskell.org/mailman/listinfo/haskell-cafe</a><br>
</div></div></blockquote></div><br><br clear="all"><br>-- <br><a href="http://www.di.uminho.pt/~hpacheco">www.di.uminho.pt/~hpacheco</a><br>
</div>