This is a simplified template for your own, public BioHack Academy Documentation Site.
Github Pages are websites that are written in Markdown and hosted on github.com. GitHub Pages are based on the Jekyll, a powerful and sometimes complex Static Site Generatator (SSG). This repository tries to make it a little bit simpler an accessible.
Fork this repo, by clicking the "Fork" button on the top right of this page.
Next, go to the Settings tab, and rename the repository to something you like - maybe something descriptive, let's say: biohack
The URL of your website will be: <yourgithubusername>.github.io/biohack
Go to the Settings tab, then click on the Pages Submenu on the left. Select your main branch as the source, and click Save. The root folder is fine for now, you can change it later. After saving, you get a message saying that your site is ready.
Github Pages let you choose an internal theme, but we want to use our BioHack Theme, we need to tell Github Pages about that.
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.
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.
Edit /about.md to change the information on the About page of your documentation site.
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
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
- 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!