From gwking at metabang.com  Tue Jun 26 23:11:32 2007
From: gwking at metabang.com (Gary King)
Date: Tue, 26 Jun 2007 19:11:32 -0400
Subject: [cl-markdown-devel] Documentation? 
In-Reply-To: <Pine.LNX.4.64.0706251537120.5111@Psilocybe.Update.UU.SE>
References: <Pine.LNX.4.64.0706251537120.5111@Psilocybe.Update.UU.SE>
Message-ID: <F416AFB5-0B06-4DA2-8DAF-1FBE115C1D94@metabang.com>

Hi Andreas,

Documentation is one of the things sorely lacking from CL-Markdown.  
For now, here is the docstring of the markdown function:

>   "Convert source into a markdown document object and optionally  
> render it to stream using format. Source can be either a string or  
> a pathname or a stream. Stream is like the stream argument in  
> format; it can be a pathname or t \(short for *standard-output*\)  
> or nil \(which will place the output into a string\). Format can  
> be :html or :none. In the latter case, no output will be generated.
>
> The markdown command returns \(as multiple values\) the generated  
> document object and any return value from the rendering \(e.g., the  
> string produced when the stream is nil\)."

So, for example,

> markdown> (markdown "
> ### Title
>
> Some text
>
> * a list
>     * with sublists
>     * and so on
> * and so on
>
> More text" :stream nil)
> #<document @ #x11c93f92>
> "<h3>Title
> </h3>
> <p>Some text
> </p><ul><li>a list
> <ul><li>with sublists
> </li><li>and so on
> </li></ul></li><li>and so on
> </li></ul><p>More text
> </p>"
> markdown>

I do hope to be able to stop developing a manual in the relatively  
near future...

Please let me know if you have any more questions,
--
Gary Warren King, metabang.com
Cell: (413) 885 9127
Fax: (206) 338-4052
gwkkwg on Skype * garethsan on AIM






From luke at balooga.com  Wed Jun 27 02:41:48 2007
From: luke at balooga.com (Luke J Crook)
Date: Tue, 26 Jun 2007 19:41:48 -0700
Subject: [cl-markdown-devel] Documentation?
In-Reply-To: <F416AFB5-0B06-4DA2-8DAF-1FBE115C1D94@metabang.com>
References: <Pine.LNX.4.64.0706251537120.5111@Psilocybe.Update.UU.SE>
	<F416AFB5-0B06-4DA2-8DAF-1FBE115C1D94@metabang.com>
Message-ID: <4681CE6C.5030408@balooga.com>

I can post a link to my modified version of Edi Weitz's
documentation-template with support for cl-markdown, if anyone is
interested.

It's what I used to generate all the lispbuilder documentation.

- Luke


From gwking at metabang.com  Wed Jun 27 12:09:22 2007
From: gwking at metabang.com (Gary King)
Date: Wed, 27 Jun 2007 08:09:22 -0400
Subject: [cl-markdown-devel] Documentation?
In-Reply-To: <4681CE6C.5030408@balooga.com>
References: <Pine.LNX.4.64.0706251537120.5111@Psilocybe.Update.UU.SE>
	<F416AFB5-0B06-4DA2-8DAF-1FBE115C1D94@metabang.com>
	<4681CE6C.5030408@balooga.com>
Message-ID: <DDCCF125-8CC4-4224-9144-63B27F5C0129@metabang.com>

Hi Luke,

Go for it!

and thanks,

On Jun 26, 2007, at 10:41 PM, Luke J Crook wrote:

> I can post a link to my modified version of Edi Weitz's
> documentation-template with support for cl-markdown, if anyone is
> interested.
>
> It's what I used to generate all the lispbuilder documentation.
>
> - Luke
> _______________________________________________
> cl-markdown-devel mailing list
> cl-markdown-devel at common-lisp.net
> http://common-lisp.net/cgi-bin/mailman/listinfo/cl-markdown-devel

--
Gary Warren King, metabang.com
Cell: (413) 885 9127
Fax: (206) 338-4052
gwkkwg on Skype * garethsan on AIM