You see, yak shaving is what you are doing when you're doing some stupid, fiddly little task that bears no obvious relationship to what you're supposed to be working on, but yet a chain of twelve causal relations links what you're doing to the original meta-task.
- Jeremy H. Brown
Save The Yak is a website with guides that will reduce the time you spend yak shaving.
If you are interested in contributing content, see the [killtheyak-pages] repo.
Save The Yak is a small Flask app that uses Flask-FlatPages and Frozen-Flask to build the static content. The app itself lives in the savetheyak/ directory. Feel free to use, modify, or just browse around.
Clone the repo
$ git clone https://github.com/anschwa/savetheyak.git --recursive
--recursive option clones the
Install the necessary Python packages (requires Python 2.7 or 3.4.n with pip):
# After activating your virtualenv $ pip install -r requirements.txt
Building the site
To run the local development server
$ python manage.py runserver
You can browse to
http://localhost:5000/ to view the site.
To build the static version of the site:
$ python manage.py build
This will build the static site to the
To deploy to GitHub Pages:
$ python manage.py deploy
This will build the site, commit to the
master branch, and push to GitHub.
Copyrights to the guides are owned by their original authors and are licensed under the [Creative Commons Attribution-Share-Alike license][CC-SA]. The website is licensed under the [MIT License].
SaveTheYak [KillTheYak]: http://killtheyak.com [killtheyak-pages]: https://github.com/killtheyak/killtheyak-pages [MIT License]: https://github.com/anschwa/savetheyak/blob/master/LICENSE [CC-SA]: https://creativecommons.org/licenses/by-sa/3.0/legalcode