Documentation

[notslang]

Back in #1175 I mentioned that I was writing a Jade book for Packt. That's just about finished, except I discovered that my publisher is rather incompetent when it comes to reviewing and editing content. To give you some idea of what I mean by "incompetent":

• "version control" was passing Word docs back and fourth via email
• I got 2 technical reviewers, and no opportunity to talk with either of them - just a list of comments they made
• no syntax highlighting in the entire book - even for the ebooks

So, rather than publish a low-quality book, I converted the entire book into Markdown, and began using GitHub to manage it and invite reviewers. This has helped progress the book immensely. However, Packt refuses to work with Markdown, Github, or pretty much anything except for Word docs.

Thus, I've decided to give up on working with them and release the contents of the book in the public domain. It will be reformatted to be more readable on the web, and I think we can use it as the new "official Jade documentation".

Repo is here: https://github.com/slang800/jade-book Thoughts?

[matejkramny]

Publish your book through amazon kindle - i think you can sell books there.. Not sure about formatting, but i own java scjp exam book (kindle edition) and it has plenty code formatted in a special way.

Matej Kramny Sent with Sparrow (http://www.sparrowmailapp.com/?sig)

On Saturday, 11 January 2014 at 15:05, Sean Lang wrote:

Back in #1175 (https://github.com/visionmedia/jade/issues/1175) I mentioned that I was writing a Jade book for Packt. That's just about finished, except I discovered that my publisher is rather incompetent when it comes to reviewing and editing content. To give you some idea of what I mean by "incompetent": "version control" was passing Word docs back and fourth via email I got 2 technical reviewers, and no opportunity to talk with either of them - just a list of comments they made no syntax highlighting in the entire book - even for the ebooks

So, rather than publish a low-quality book, I converted the entire book into Markdown, and began using GitHub to manage it and invite reviewers. This has helped progress the book immensely. However, Packt refuses to work with Markdown, Github, or pretty much anything except for Word docs. Thus, I've decided to give up on working with them and release the contents of the book in the public domain. It will be reformatted to be more readable on the web, and I think we can use it as the new "official Jade documentation". Repo is here: https://github.com/slang800/jade-book Thoughts?

— Reply to this email directly or view it on GitHub (https://github.com/visionmedia/jade/issues/1385).

[notslang]

Good idea. I'm still planning on giving it away for free online, but I could use that for providing kindle and maybe physical copies.

[ForbesLindesay]

I'm happy to look at pulling bits of it in as part of the jade documentation. The docs site does need a lot of work. I think we should probably ditch the current "tutorial" section and build something more like reference documentation. Tutorials are more suited to blog posts/conference talks/videos anyway. If we integrate it into the site, we can make most of the examples interactive as well, which would be nice.

At the moment, updating the jade-lang site is something I'd really like to do, but it takes a lot of time, and I don't have much time at the moment.

[DaveAuld]

Forbes, I wrote an article on Jade yesterday over at CodeProject, still needs a few errors,typos etc. fixing, but generally the content is all there.

Was going to place a link in the wiki home page, or you might have other places it might also benefit the community being referenced to.

http://www.codeproject.com/Articles/717798/Feeling-Jaded-with-Jade

Did want to add links to external content without your thoughts first. Cheers, Dave