luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Merge pull request #315 from drnic/publish-website 

website - how to build & deploy site
This commit is contained in:
Armon Dadgar 2014-09-02 10:48:43 -07:00
parent 8e5e3fea20 e243e33786
commit 12fe5d0b9e
1 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
website/README.md
View File

@ -1,24 +1,36 @@
# Consul Website
Consul Website
==============
This subdirectory contains the entire source for the [Consul Website](http://www.consul.io).
This is a [Middleman](http://middlemanapp.com) project, which builds a static
site from these source files.
This subdirectory contains the entire source for the [Consul Website](http://www.consul.io). This is a [Middleman](http://middlemanapp.com) project, which builds a static site from these source files.
## Contributions Welcome!
Contributions Welcome!
----------------------
If you find a typo or you feel like you can improve the HTML, CSS, or
JavaScript, we welcome contributions. Feel free to open issues or pull
requests like any normal GitHub project, and we'll merge it in.
If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in.
## Running the Site Locally
Running the Site Locally
------------------------
Running the site locally is simple. Clone this repo and run the following
commands:
Running the site locally is simple. Clone this repo and run the following commands:
```
$ bundle
$ bundle exec middleman server
```
Then open up `localhost:4567`. Note that some URLs you may need to append
".html" to make them work (in the navigation and such).
Then open up `localhost:4567`. Note that some URLs you may need to append ".html" to make them work (in the navigation and such).
Building Site
-------------
Building the static version of the site and running it is simple. Clone this repo and run the following commands:
```
$ bundle
$ bundle exec middleman build
$ foreman start
```
Then open up `localhost:5000`.
Alternately, the site can now be deployed to Heroku or Cloud Foundry.