Bixbite template structure

Overview

Bixbite’s built-in template is highly-optimized for client-side development. Here’s an overview of assumptions made while developing the template:

• You are primarily a client-side developer.
• You use LABjs for parallelized script downloads.
• All JavaScript and CSS files are uncompressed and individually maintained during development. (PHP Minify is bundled with the template, however it is assumed that use of Minify is for testing only.) Bixbite comes with Rake tasks that will output compressed and concatenated files for delivery.

Template Structure

- template
	- assets
		- _local
		- bixbite
		- naturaldocs
		- utilities
	- deploy
		- public_html
	- documentation
		- js
	- src
		- html
			- css
			- images
			- includes
			- js
			- min
		- yaml
		- templates

Directory: assets

The assets directory includes project specific files, such as local PSD compositions and executables.

• _local – User editable. Should contain local assets ignored by version control, such as large PSD files.
• bixbite – Contains Bixbite rake tasks. This directory should not be edited. Use the Rakefile in the template root to add your own tasks.
• naturaldocs – Contains NaturalDocs support files and executable.
• utilities – User editable. A catch-all for superfluous executable files. Contains the OptiPNG executable.

Directory: deploy

The deploy directory contains deliverables. This directory should only include files that are considered deployable.

• public_html – Contains files generated by Bixbite’s Rake tasks.

Directory: documentation

The documentation directory contains generated documentation.

• js – Contains JavaScript documentation generated by NaturalDocs. Part of the Bixbite Rake tasks.

Directory: src

The src directory contains source files, including Bixbite-specific dynamic templates.

• html – The html directory should be treated as your development environment’s document root. It contains all HTML source files.
  • css – CSS directory root.
    • cmn – A common directory for globally-shared CSS files
  • images – Image directory root.
    • cmn – A common directory for globally-shared image files
  • includes – Contains PHP include files.
  • js – JavaScript directory root.
    • cmn – A common directory for globally-shared JavaScript files
  • min – Contains PHP Minify source files.
• yaml – The yaml directory contains YAML config files
• templates – The templates directory contains CSS/JS/HTML templates used when generating new page templates with Bixbite Rake tasks.