diff --git a/.gitignore b/.gitignore index 4bb1e14ac..f10746dc8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ _site .sass-cache .jekyll-metadata +.vagrant project.pbxproj *.xcworkspacedata *.xcscmblueprint diff --git a/README.md b/README.md index f1180e067..493cb469f 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ Our documentation is built with Jekyll and served through Github Pages. In order to run Jekyll locally, you also need Ruby being installed. Please see the [Jekyll installation instructions](https://jekyllrb.com/docs/installation/) for details. +An alternative for a local setup is a virtual machine provided by Vagrant. + ## Serving the Documentation locally Once you have Jekyll installed and the repository checked out, simply run @@ -29,6 +31,19 @@ from within the repository root folder and point your browser to [`http://localh This will give you a preview of the documentation in the same way as it will appear on docs.openhab.org once your PR is merged. Changes to the markdown files will automatically be taken into account as Jekyll re-generates the pages on the fly. +### Alternative: Vagrant VM + +You can also have a virtual machine serving a Jekyll and webserver instance for you, without changing your base system or being limited by it. +The virtual machine will run in the background, process your changes to the source and presenting the results on your hosts [`http://localhost:4000`](http://localhost:4000). +A [Vagrant](https://www.vagrantup.com) machine configured by a [`Vagrantfile`](Vagrantfile) file is provided for that purpose. + +You need to have [VirtualBox](https://www.virtualbox.org) and [Vagrant](https://www.vagrantup.com/downloads.html) installed. +After that, it's as easy as: + +```shell +/path-to/openhab-docs$ vagrant up +``` + ## Automatically Generated Parts Please note that a few parts MUST NOT BE MANUALLY EDITED! diff --git a/Vagrantfile b/Vagrantfile new file mode 100644 index 000000000..79a3afe50 --- /dev/null +++ b/Vagrantfile @@ -0,0 +1,19 @@ + +$script = <