lua-cookbook made prettier..

[steve donovan]

Hi all,

I've taken the markdown source for the 'introduction' I started
writing a while back at

https://github.com/lua-cookbook/lua-cookbook

and rendered it more nicely using LDoc

http://stevedonovan.github.com/lua-cookbook/

There's definitely room for improvement in that style sheet[1], but
the idea is to make it easier to read than the original Markdown.

LDoc made it easier, because it has built-in code prettifiers and has
@{} intra-doc links. (It _did_ occur to me that text-only projects in
LDoc would not be difficult at all)

It's still far too concise, and it's time to start talking about the
standard libraries in more depth.

steve d.

[1] one of the ways in which the internet can make me happy is to
suggest better style sheets ;)

[Andrew Starks]

Steve,

You're awesome. You're inspiring me to take a day off and actually do
something for this project, instead of only typing ranty emails (which
looks more like work than opening Photoshop and friends).

-Andrew

[Ryan Pusztai]

On Thu, Mar 21, 2013 at 1:51 PM, steve donovan <steve.j...@gmail.com> wrote:

Hi all,

I've taken the markdown source for the 'introduction' I started
writing a while back at

https://github.com/lua-cookbook/lua-cookbook

and rendered it more nicely using LDoc

http://stevedonovan.github.com/lua-cookbook/

There's definitely room for improvement in that style sheet[1], but
the idea is to make it easier to read than the original Markdown.

 LDoc made it easier, because it has built-in code prettifiers and has
@{} intra-doc links.  (It _did_ occur to me that text-only projects in
LDoc would not be difficult at all)

It's still far too concise, and it's time to start talking about the
standard libraries in more depth.

Nice work.

--

Regards,
Ryan

 

[Paul K]

Hi Steve,

 

> There's definitely room for improvement in that style sheet[1], but
> the idea is to make it easier to read than the original Markdown.

Nice work! I always liked this format and like the content of this cookbook.

 

FWIW, ZBS can recognize Markdown links in comments and provide cross-file navigation. This is exactly what I use for links in EduPack: https://github.com/pkulchenko/ZeroBraneEduPack/blob/master/zerobrane-lessons/00-contents.lua. The only non-standard addition is that + in front of a link will direct ZBS to open it in a new tab. But other than that, clicking on an external link will open a browser and on an internal link will load and open the file in the IDE. The user can then run the snippets or copy them to the local console. In fact, you may even add "Run this" link that fill be executed in the local console:

 

[Run this](macro:shell(2+3)) -- will put 2+3 in the local console and execute it

 

Paul.

[steve donovan]

On Thu, Mar 21, 2013 at 10:38 PM, Paul K <paulc...@gmail.com> wrote:
> FWIW, ZBS can recognize Markdown links in comments and provide cross-file
> navigation. This is exactly what I use for links in EduPack:

Yes, I remember how you do your tutorial - that's an excellent
feature. For instance, people would like to see docs for a function;
ZBS could display them nicely in another buffer (or a popup, I
wonder?).

It's useful to show hyperlinks in code comments as well.