Jekyll Apple Help

screenshot of Jekyll Apple Help

Easily create Apple Help-Books for your Mac OS X app using this Jekyll template and build system.

Overview

Jekyll Apple Help is a Jekyll template and Xcode build system that simplifies the process of authoring and building Mac OS X Help Books. It allows developers to add help documentation to their Mac apps and author content in Markdown. The resulting Help Books have the same look and feel as Apple's Yosemite apps.

Features

  • Use Markdown to write help topics: Developers can write their help documentation in Markdown, a lightweight markup language that is easy to use and understand.
  • Xcode integration: The template seamlessly integrates with Xcode, allowing developers to easily add the help documentation to their app projects.
  • Automatic and flexible navigation menu: The template automatically generates a navigation menu for the help documentation, making it easy for users to navigate through the content.
  • Automatic help index generation: The template automatically generates a help index, making it easy for users to search for specific topics.
  • Styled like Yosemite's help: The resulting Help Books have the same visual style as Apple's Yosemite apps, providing a consistent user experience.
  • Supports multi-lingual help: The template supports the creation of help documentation in multiple languages, allowing developers to cater to a global audience.

Summary

Jekyll Apple Help is a useful tool for indie developers who want to add help documentation to their Mac apps. By combining the power of Jekyll's static site generation with Xcode's build system, developers can easily author and build Mac OS X Help Books that have the same look and feel as Apple's Yosemite apps. The template supports Markdown for writing help topics, provides automatic navigation and index generation, and supports multi-lingual help. Overall, Jekyll Apple Help simplifies the process of creating help documentation for indie developers and provides a seamless integration with Xcode.