bitovi / bios

Bitovi Employee Bios

Static site generator for Bitovi LLC employee bios

• Installation
• Adding Content
• Markdown Structure
• Removing Content

Installation

$ git clone git@github.com:bitovi/bios.git
$ cd bios
$ npm install

Adding Content

• Create a new branch off master named adding-<firstname>-<lastname> where <firstname> is the first name of the person being added and <lastname> is the lastname of the person being added. (git checkout -b adding-<firstname>-<lastname> origin/master).
• Create a new directory in the content directory named <firstname>-<lastname>.
• For the included headshot add an image in the <firstname>-<lastname> directory named headshot.<*> where <*> is any recognized image extension.
• Add a Markdown file named <firstname>-<lastname>.md to the <firstname>-<lastname> directory.
• Edit the Markdown file.
• Push the branch to the remote and create a Pull Request in the repository.

Markdown Structure

Each Markdown file is structured as three parts: the name and title (metadata), highlights (an unordered list), and the body (N number of paragraphs). For example please reference Mark Stahl's Markdown file.

Deviating from this structure will have unintended consequences.

Removing Content

• Create a new branch off master named removing-<firstname>-<lastname> where <firstname> is the first name of the person being added and <lastname> is the lastname of the person being added. (git checkout -b removing-<firstname>-<lastname> origin/master).
• Delete the appropriate individual's directory from the content directory.
• Push the branch to the remote and create a Pull Request in the repository.