Documentation workflow script availability

Phil's Avatar


09 Apr, 2012 11:54 AM

Brett -- in a discussion w/ Julien (problems) you mentioned your documentation workflow script.

" My own documentation projects use raw Markdown files with build scripts to wrap the processed files in template HTML. I view the documents in Marked with no "chrome" as I work, and then when I want a full preview of the site, I run the build script and it processes either the current file or the whole tree, applies the sidebar, header, etc, then opens it as a local server. Most of my projects take about 3 seconds to build and refresh the web page, so it's pretty snappy. Marked handles showing me the result of my Markdown, and the rest is left up to build scripts and my web browser."

My question is: would you be willing to share this script?


  1. Support Staff 1 Posted by Brett on 09 Apr, 2012 12:58 PM

    Brett's Avatar

    I'll post it here as soon as I have a chance to comment it a little so that it's more readable.


  2. 2 Posted by Philip Davis on 09 Apr, 2012 01:08 PM

    Philip Davis's Avatar

    Thanks! I am assuming that this is what you used to create your new help files (which are excellent). I'm creating a set of tech tip files for our Mac User Group and having a script to facilitate the workflow would be a very big time saver.

    I continue to be impressed by the quality of your work and by the amount of time you spend serving as your own "support staff." This is much appreciated.


  3. Support Staff 3 Posted by Brett on 11 Apr, 2012 09:35 PM

    Brett's Avatar

    Sorry for the delay on this, hoping to have time to post the script in the next day or two.

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:


Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac