Skip to content

Setting up a custom template

doctyper edited this page Sep 13, 2010 · 2 revisions

Overview

Because the bundled template might not suit everyone’s tastes, Bixbite provides a method to substitute the template for your own. You can take a look at the default Bixbite template for reference.

There are two ways to use a custom template in Bixbite:

Specifying a source directory during build time

You can specify a custom directory when envoking Bixbite. For example:

bixbite "Project Title" PROJECTNAMESPACE /path/to/custom-template

Defaulting to a custom template

You can also allow Bixbite to use your custom template for all builds:

bixbite --source-directory /path/to/custom-template

Note that sudo privileges are required to run this command.

Building a custom template

Building your own template allows you tons of flexibility when initializing projects. In a nutshell, you may include anything you’d like in a template, as long as paths are properly referenced. Please see the YAML config files for how to format paths.

Bixbite targets file content by a set of reserved keywords. It looks for these keywords and replaces them with predetermined variables (such as project name, project namespace, etc).

Please see Reserved keywords for a complete list.