mirror of https://github.com/status-im/consul.git
48bc581470
* Moved the glossary to a new page and removed the advanced warnings from all internals docs. * Update website/source/layouts/docs.erb Co-Authored-By: Judith Malnick <judith@hashicorp.com> * Updates based on PR feedback * Update website/source/docs/internals/index.html.md * Update website/source/docs/internals/index.html.md * Update website/source/docs/internals/index.html.md * Update website/source/docs/internals/index.html.md * Update website/source/docs/internals/index.html.md |
||
---|---|---|
.. | ||
raw-assets | ||
scripts | ||
source | ||
Gemfile | ||
Gemfile.lock | ||
LICENSE.md | ||
Makefile | ||
README.md | ||
config.rb | ||
report.xml |
README.md
Consul Website
This subdirectory contains the entire source for the Consul Website. This is a Middleman project, which builds a static site from these source files.
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.
Running the Site Locally
Running the site locally is simple. Clone this repo and run make website
.
Then open up http://localhost:4567
. Note that some URLs you may need to append
".html" to make them work (in the navigation).