Home

Welcome to the howzit wiki!

Howzit is a tool that allows you to keep Markdown-formatted notes about a project's tools and procedures. It functions as an easy lookup for notes about a particular task, as well as a task runner to automatically execute appropriate commands.

Features

• Match topic titles with any portion of title
• Automatic pagination of output, with optional Markdown highlighting
• Use @run(), @copy(), and @open() to perform actions within a build notes file
• Use @include() to import another topic's tasks
• Use fenced code blocks to include/run embedded scripts
• Sets iTerm 2 marks on topic titles for navigation when paging is disabled
• Inside of git repositories, howzit will work from subdirectories, assuming build notes are in top level of repo
• Templates for easily including repeat tasks
• Grep topics for pattern and choose from matches

Get started here:

• Configuration
• Using Howzit