1password-touch-help

This project includes source code for integrated 1Password help.

It can be useful to a developer who need a simple tool to create built-in help systems for Mac OS X applications. The project includes a script to generate standard Mac OS X application help files.

The idea is to minimize the amount of maintenance work required to compile the documentation: - the structure of the help is defined via directory structure - the source documents are written with Markdown

The generate script will scan the directory structure and automatically prepare table of contents and convert markdown formatting into proper XHTML with standard header and footer as defined by the help template.

The generate script is based on Ruby and uses Maruku gem for Markdown.

How to use: 1. Install maruku (gem install maruku) 2. Checkout the project 3. Run ./script/generate and it will create "html" subdirectory with the XHTML help files for the application.

To customize help for your application you will need to edit the markdown files in "source" folder and help template files and stylesheets in "template" folder.