BioHack Academy Github page template

After building and using your lab, the third and most crucial step in becoming a biohacker is sharing your experience with others. For that you'll need a documentation site. Using this template, you will have that site up and running in no time in your own GitHub account!

Quick Start

Step 1) Fork Jekyll Now to your User Repository

Fork this repo, by clicking the "Fork" button on the top right of this page.

Step 2) Rename the repository

Next, go to the settings tab, and rename the repository to yourgithubusername.github.io (so remove BHA_DocumentationSite) It has to be exactly this, otherwise the site won't build.

Your documentation site be viewable immediately at http://yourgithubusername.github.io (if it's not, you can often force it to build by completing step 3)

Step 3) Customize and view your site

Configure your site name, description and url by editing the _config.yml file.

You can easily turn on Google Analytics tracking, Disqus commenting and social icons here too.

Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with Jekyll. Your rebuilt site will be viewable a few seconds later at http://yourgithubusername.github.io - if not, give it ten minutes as GitHub suggests and it'll appear soon

There are 3 different ways that you can make changes to your blog's files:

Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).

Use a third party GitHub content editor, like Prose by Development Seed. It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy.

RECOMMENDED: Clone down your repository to your harddrive and make updates locally, then push them to your GitHub repository, using Github Desktop. Here's a great tutorial.

Step 4) Publish your first blog post

Edit /_posts/2016-2-23-Hello-World.md to publish your first blog post. This Markdown Cheatsheet might come in handy.

You can add additional posts in the browser on GitHub.com too! Just click on Create new file in /_posts/ to create new content. Just make sure to include the front-matter block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md (just like 2016-2-23-Hello-World.md ). Note that posts with a date in the future will not show.

Step 5) Change the About Pages

Edit /about.md to change the information on the About page of your documentation site.

Moar!

There is a more detailed walkthrough, Build A Blog With Jekyll And GitHub Pages over at the Smashing Magazine website. Check it out if you'd like a more detailed walkthrough and some background on Jekyll.

It covers:

A more detailed walkthrough of setting up your Jekyll blog
Common issues that you might encounter while using Jekyll
Importing from Wordpress, using your own domain name, and blogging in your favorite editor
Theming in Jekyll, with Liquid templating examples
A quick look at Jekyll 2.0’s new features, including Sass/Coffeescript support and Collections

Other forkable themes

You can use the Quick Start workflow with other themes that are set up to be forked too! Here are some of my favorites:

Hyde by MDO
Lanyon by MDO
mojombo.github.io by Tom Preston-Werner
Left by Zach Holman
Minimal Mistakes by Michael Rose
Skinny Bones by Michael Rose

Credits

Jekyll Now
Jekyll - Thanks to its creators, contributors and maintainers.
SVG icons - Thanks, Neil Orange Peel. They're beautiful.
Solarized Light Pygments - Thanks, Edward.
Joel Glovier - Great Jekyll articles. I used Joel's feed.xml in this repository.
David Furnes, Jon Uy, Luke Patton - Thanks for the design/code reviews.
Bart Kiers, Florian Simon, Henry Stanley, Hun Jae Lee, Javier Cejudo, Peter Etelej - Thanks for your fantastic contributions to the project!

vanne89 Goto Github PK