This is a simple Jekyll design documentation site based on Hyde/Poole. I've started the site out with some key pages and tag grouping (research).

This project uses GitHub pages and is set up so that you can edit files locally, sync the changed files with GitHub.com, and allow GitHub pages to render the Jekyll, so that you do not need to run Jekyll locally. These instructions assume you’re using the GitHub desktop client and have a GitHub.com account.

• Install GitHub Desktop client if you don’t already have it.
• Fork this repo to your account or team.
• Clone the repo by clicking the green button, choosing Open in Desktop from the menu. (I have created a Sites directory inside my Mac user directory, along side Documents, Downloads, etc. where I keep my local repos.)
• On the Settings tab, change the Repository name to the name of your choice.
• On the Settings tab, in the GitHub Pages section, change the Source to “master branch”.
• The site should now be visible at https:username.github.io/reponame (replacing the italicized text with your username/team name and repo name). Note: the links will point to the original repo, so we’ll change that now.)
• In a text editor such as Atom, locate your local copy of the repo and open the _config.yml file.
• in the Setup section, replace the title, tagline, description, url, and baseurl. The url and baseurl values need to be changed to point to your new site’s location which should follow the username.github.io/reponame convention. Further down you can also change the repo value to point to your github.com repo’s URL. Save these changes.
• Open GitHub for Mac client. You should be able to select your local copy of the repo from the menu on the left. Select the repo. Select “master” from the branch selection menu near the top left.
• You should see an uncommitted change. Add a brief commit summary and click “Commit to master”. Then, at the upper right, click the “Sync” button to push the changes up to github.com. You links should not be correct and your site working.

Posts are written in markdown and found in the _posts directory. You’ll see there are a number of dummy posts already there. Notice the file naming convention defines the posts’ publish date. Remove of edit the posts as you’d like.

The post named _posts/2012-02-07-example-content.md shows a variety of text formatting options.

If you open a post in your text editor, you’ll see some information near the top that’s sectioned off. This is the **YAML front matter. This is metadata about your post. You define the post’s title there.

Some posts include tags in the YAML front matter. In this example, a few posts have “research” as a tag, which allows those posts to be included on the Research page (see research.md).

There are a few pages included in the root directory. These are just static pages and not chronological in nature, as posts are. They are also written in markdown. These pages can be edited or removed. They have been linked to from the sidebar ( found in /_includes/sidebar.html ).

The Research page has been set up as a page for listing all posts that are tagged “research’. You can use this as an example for making other tag category pages.