home-assistant.github.io/README.markdown
Fabian Affolter be08601875 Fix markup
2015-12-09 13:39:07 +01:00

76 lines
1.9 KiB
Markdown

# Home Assistant website
This is the source for the [Home Assistant](https://github.com/balloob/home-assistant) website available at [Home-Assistant.io](https://home-assistant.io).
## Jekyll project to generate and deploy
| Command | Action |
|---|---|
| `rake preview` | Preview site on [http://127.0.0.1:4000](http://127.0.0.1:4000)
| `rake generate` | Generate new version of the site
| `rake deploy` | Deploy a new version of the site
## Setup
_You need to have Ruby installed._
- [Ruby installation instructions](https://www.ruby-lang.org/en/documentation/installation/)
- For Fedora and CentOS check the last section of this file.
```bash
$ git clone --recursive https://github.com/balloob/home-assistant.io.git
$ cd home-assistant.io
$ bundle
```
## Create a new blog post
```bash
$ rake new_post["title"]
```
## Site preview
```bash
$ rake preview
```
The preview is now available on [http://127.0.0.1:4000](http://127.0.0.1:4000).
## Steps for the deployment of the site
All developers with write access to the repositories are able to deploy the website. The deploy process is fully automated with `rake generate && rake deploy`.
```bash
$ git submodule update --init
$ cd _deploy
$ git fetch
$ git pull origin gh-pages
$ cd ..
$ rake generate && rake deploy
```
```bash
TZ=UTC rake generate && rake deploy
```
### Setup on Fedora and CentOS
On Fedora > 22 or CentOS 7.1.1503 Ruby is not available by default. Please take the notes here as a little guide for the Ruby installation process.
```bash
$ curl -sSL https://rvm.io/mpapis.asc | gpg2 --import -
$ curl -L get.rvm.io | bash -s stable
$ source ~/.profile
$ rvm requirements
$ rvm install ruby-2.2.3
$ rvm use ruby-2.2.3 --default
$ ruby -v
```
The last command will give you something like this `ruby 2.2.3p173 (2015-08-18 revision 51636) [x86_64-linux]`. Then install `bundler`.
```bash
$ gem install bundler
```
Now please follow the Setup instructions above.