I have had a few friends that turned me on to
pandoc for writing documentation. At my current job, we use Microsoft Word for writing unstructured, one-off howto documents for our end users. I would like to start writing them in markdown for the following reasons.
- separation of content from structure.
- the ability to use change control systems to track updates
- Build a standard template that includes a logo, boilerplate company text, a layout that is common to all subsequent documentation.
I would like to build a few templates that will allow all documents to contain the same flow of information to our users. The goal is add a professorial look to our IT department user documentation.
I imagine that a company hosted wiki may suffice, but the decision makers won't allow that at this given time.
What I am looking for is help in adding elements like a logo, and standard text that can be added to an HTML or PDF template. Also, I would like to define macros like encapsulating a word in
! bangs would highlight that word according to a set of rules, like keys on a keyboard or buttons of a software GUI. In contrast, encapsulating a word in
& ampersands would change the style to signify the name of a GUI Menu element.