It is hosted on Github Pages but with a custom domain name. The site regeneration and deplyoment happens automatically via travis-ci whenever something is pushed to the
source branch (thanks to this guide).
Eventually I might create / edit posts on prose.io, which makes it even easier on mobile devices or else if you don't have Git / Ruby etc. installed. But usually I prefer to work locally, in which case the workflow is:
- clone repo and check out the
sourcebranch (never edit
git clone email@example.com:tknerr/tknerr.github.io.git
git checkout source
- create / edit the posts
rake new_post["some title"]
- preview your changes
rake generate(first time only, or whenever layout or config changes)
rake preview &(or
start /B rake previewon windows)
- deploy changes
git add . && git commit -m "add new blog post about foo"
git push origin source
Credits to @trunkclub for their guide on setting this whole thing up.
Get the Environment Up and Running in Docker
To get the environment up and running in docker, start a
- in interactive mode (
-it), still you can detach from it via
ctrl-q, and use
docker attachto re-attach
- with the current directory mounted to
/repoinside the container (
- with port 4000 forwarded to http://localhost:4040 (
Start it with
/bin/bash as the entry point to get a bash session you can work in:
docker run -it -p 4040:4000 -v $(pwd):/repo ruby:1.9.3 /bin/bash > cd /repo > bundle install > export RUBYOPT="-KU -E utf-8:utf-8" > rake new_post["foo"] > rake isolate["foo"] > rake preview > # ... write blog post > rake integrate > rake generate > rake setup_github_pages["https://firstname.lastname@example.org/tknerr/tknerr.github.io.git"] > rake deploy
For a one-off command to generate the site and run it in preview mode:
docker run --rm -it -p 4040:4000 -v $(pwd):/repo ruby:1.9.3 /bin/bash -c 'cd /repo; export RUBYOPT="-KU -E utf-8:utf-8"; bundle install; rake generate; rake preview'
What is Octopress?
Octopress is Jekyll blogging at its finest.
- Octopress sports a clean responsive theme written in semantic HTML5, focused on readability and friendliness toward mobile devices.
- Code blogging is easy and beautiful. Embed code (with Solarized styling) in your posts from gists, jsFiddle or from your filesystem.
- Third party integration is simple with built-in support for Pinboard, Delicious, GitHub Repositories, Disqus Comments and Google Analytics.
- It's easy to use. A collection of rake tasks simplifies development and makes deploying a cinch.
- Ships with great plug-ins some original and others from the Jekyll community — tested and improved.
Note: Octopress requires a minimum Ruby version of
We love to see people contributing to Octopress, whether it's a bug report, feature suggestion or a pull request. At the moment, we try to keep the core slick and lean, focusing on basic blogging needs, so some of your suggestions might not find their way into Octopress. For those ideas, we started a list of 3rd party plug-ins, where you can link your own Octopress plug-in repositories. For the future, we're thinking about ways to easier add them into our main releases.
(The MIT License)
Copyright © 2009-2013 Brandon Mathis
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
If you want to be awesome.
- Proudly display the 'Powered by Octopress' credit in the footer.
- Add your site to the Wiki so we can watch the community grow.