Comments on: Writing Simple, Effective Documentation http://www.huyng.com/archives/writing-simple-effective-documentation/102/ Mon, 16 Aug 2010 10:05:24 +0000 http://wordpress.org/?v=2.9.2 hourly 1 By: Jeremy http://www.huyng.com/archives/writing-simple-effective-documentation/102/comment-page-1/#comment-2628 Jeremy Sat, 22 May 2010 16:06:53 +0000 http://www.huyng.com/?p=102#comment-2628 Could you post about your LaTex and PDFTex installations? I'm having a terrible time getting the two working right to take the MMD file and convert it to PDF. I assume I've not installed the MacTex and the PDFTex packages correctly, but find no real Internet resources about doing this with MMD. Could you post about your LaTex and PDFTex installations? I’m having a terrible time getting the two working right to take the MMD file and convert it to PDF. I assume I’ve not installed the MacTex and the PDFTex packages correctly, but find no real Internet resources about doing this with MMD.

]]> By: Simon http://www.huyng.com/archives/writing-simple-effective-documentation/102/comment-page-1/#comment-2121 Simon Sun, 17 Jan 2010 17:16:11 +0000 http://www.huyng.com/?p=102#comment-2121 I also had problems with Pandoc, more because 10.6.2 is 64 bit and lots of dependencies aren't. However, Using these instructions I managed to install it ok: http://www.haskell.org/haskellwiki/Mac_OS_X Do you think Pandoc has a greater number of formats it will convert into than multimarkdown? I plus for me with Pandoc is that it does have a plugin for WordPress. The big downer is that there's no textmate bundle at present, well, none that i could find. I also had problems with Pandoc, more because 10.6.2 is 64 bit and lots of dependencies aren’t. However, Using these instructions I managed to install it ok: http://www.haskell.org/haskellwiki/Mac_OS_X

Do you think Pandoc has a greater number of formats it will convert into than multimarkdown?

I plus for me with Pandoc is that it does have a plugin for WordPress. The big downer is that there’s no textmate bundle at present, well, none that i could find.

]]> By: Applicative http://www.huyng.com/archives/writing-simple-effective-documentation/102/comment-page-1/#comment-1039 Applicative Mon, 27 Jul 2009 02:21:47 +0000 http://www.huyng.com/?p=102#comment-1039 Pandoc is easy to install on a mac with the binary installer for Haskell Platform http://hackage.haskell.org/platform/ It installs the GHC and then major libraries and tools ... including the general Haskell package manager, cabal, which makes all of hackage available. So then, in the terminal, you just type "cabal install pandoc". --Or better add the flags for syntax highlighting of code in appropriate output types, and for the associated scripts like "markdown2pdf" ... so then it would be "cabal install pandoc -fhighlighting -fwrappers" (Strangely, I did this just a couple of minutes ago for the new version, and just hit your essay by a google search.) Textmate's markdown bundle does pretty good highlighting with pandoc-markdown, it is easy to add a few pandoc-appropriate commands and snippets - for example, for instant previewing of selected text in the textmate browser. Pandoc is easy to install on a mac with the binary installer for Haskell Platform
http://hackage.haskell.org/platform/
It installs the GHC and then major libraries and tools … including the general Haskell package manager, cabal, which makes all of hackage available. So then, in the terminal, you just type
“cabal install pandoc”.

–Or better add the flags for syntax highlighting of code in appropriate output types, and for the associated scripts like “markdown2pdf” … so then it would be
“cabal install pandoc -fhighlighting -fwrappers”

(Strangely, I did this just a couple of minutes ago for the new version, and just hit your essay by a google search.)

Textmate’s markdown bundle does pretty good highlighting with pandoc-markdown, it is easy to add a few pandoc-appropriate commands and snippets – for example, for instant previewing of selected text in the textmate browser.

]]> By: Johntron http://www.huyng.com/archives/writing-simple-effective-documentation/102/comment-page-1/#comment-931 Johntron Thu, 05 Mar 2009 22:25:15 +0000 http://www.huyng.com/?p=102#comment-931 Good article. Andy Hunt did something very similar to this with the Pragmatic Programmer book. It's nice to see a full-lenght tutorial. Good article. Andy Hunt did something very similar to this with the Pragmatic Programmer book. It’s nice to see a full-lenght tutorial.

]]> By: Huy http://www.huyng.com/archives/writing-simple-effective-documentation/102/comment-page-1/#comment-930 Huy Wed, 04 Mar 2009 06:55:53 +0000 http://www.huyng.com/?p=102#comment-930 Ryan, thanks for notifying me of this. I just had the files in the wrong directories. Try the links again, they should work this time. Ryan, thanks for notifying me of this. I just had the files in the wrong directories. Try the links again, they should work this time.

]]> By: Ryan http://www.huyng.com/archives/writing-simple-effective-documentation/102/comment-page-1/#comment-929 Ryan Wed, 04 Mar 2009 02:43:39 +0000 http://www.huyng.com/?p=102#comment-929 This is an excellent post!! However, I cannot view your sample markdown, pdf, and xhtml. Did you not upload them? This is an excellent post!! However, I cannot view your sample markdown, pdf, and xhtml. Did you not upload them?

]]>