Add install instructions

[linuxcaffe]

I use vimwiki and I'd like to try vimwikiblog, it looks great, but I'm not much of an expert, are there install instruction somewhere? and if not, could an INSTALL file be written and included? please and thank you! :)

[chrisju]

I has wrote a chinese guide but no english. I will write something in english.

[linuxcaffe]

That's great Chrisju, if I could read chinese, I wouldn't be bothering you
(not true; I would be bothering you with some other detail ;-)

[linuxcaffe]

Hey, so I'm part of the taskwarrior(.org) development team (the designer) and we're in some early exploration creating a companion web application. I think vimwiki and vimwikiblog make sense for the content-part, considering the average taskwarrior user loves the console and uses vim.

So I'm thinking, maybe I can help with the English documentation for vimwikiblog; you go ahead and write it in terrible English (sorry, it's much better than my Chinese ;-) and I'll edit and rewrite (if needed), I'm a bad programmer but a good writer.

sound good?

[linuxcaffe]

What format is the existing help text in? vimwiki? should it be like vim help-text, vimwikiblog.txt?

or, how about this; for the TWeb help system, we start with (6!) manpages, and I am looking at ways to go md2manpage, like https://github.com/rtomayko/ronn, although, not using ruby, maybe more like; https://github.com/isaacs/ronnjs, and rendering as html like this; http://rtomayko.github.io/ronn/ronn.1
As markdown source, it would also work fine in regular vimwiki.

If you think the idea is interesting, and could help integrate that sort of function in vimwikiblog, then I would be happy to write vimwikiblog a long, detailed and grammatically corretc English manpage :) .. just an idea!

anyway, thanks!

[linuxcaffe]

the isaacs/ronnjs link was a cold trail, that source code now lives here; https://github.com/kapouer/marked-man

[chrisju]

I think a .wiki file as the help text will cool. Maybe i can finish it tomorrow :)

[linuxcaffe]

awesome!

On 5 December 2013 05:38, chrisju notifications@github.com wrote:

I think a .wiki file as the help text will cool. Maybe i can finish it
tomorrow :)

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/1#issuecomment-29887499
.

[chrisju]

http://blog.zzbalabala.com/blog/vimwikiblog_en.html
It is generate from wiki/help.wiki

[chrisju]

You can modify wiki/help.wiki to make it better