yttt/yamatotoma.to
2
0
Fork 0
Code Pull requests Activity Actions

Vagrant support

Browse source 
Add vagrant support for easy local development
This commit is contained in:
Administrator 2015-11-21 14:33:33 -02:00
parent 015630eaad
commit 5d503fe83c
6 changed files with 209 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -13,6 +13,7 @@ If you need a bit of help or have comments, feel free to [contact me](http://dea
- [Prerequisites](#prerequisites)
- [Build your website in 3 steps](#build-your-website-in-3-steps)
- [Add your own content](#add-your-own-content)
- [Local Development](#local-development)
- [Last important thing: YAML front matter](#last-important-thing-yaml-front-matter)
- [Features](#features)
- [More advanced features](#more-advanced-features)
@ -64,6 +65,13 @@ Any file that you add inside the [`_posts`](./_posts) directory will be treated
As mentioned previously, you can use [prose.io](http://prose.io/) to add or edit files instead of doing it directly on GitHub, it can be a little easier that way.
###Local Development on *nix and windows
- 1) Install [VirtualBox](http://virtualbox.org) and [Vagrant](https://www.vagrantup.com).
- 2) Clone down your fork `git clone git@github.com:yourusername/yourusername.github.io.git`
- 3) Inside your repository folder call `vagrant up`
- 4) View your website at http://0.0.0.0:4000 on *nix or http://127.0.0.1:4000 on windows.
- 5) Commit any changes and push everything to the master branch of your GitHub user repository. GitHub Pages will then rebuild and serve your website.
### Last important thing: YAML front matter
In order to have your new pages use this template and not just be plain pages, you need to add [YAML front matter](http://jekyllrb.com/docs/frontmatter/) to the top of each page. This is where you'll give each page some parameters that I made available, such as a title and subtitle. I'll go into more detail about what parameters are available later. If you don't want to use any parameters on your new page (this also means having no title), then use the empty YAML front matter: