lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Jekyll run documentation for Mac improved (#612)

Browse Source 
Signed-off-by: Dominic Schabel <dominic.schabel@bosch-si.com>
This commit is contained in:
Dominic Schabel
2017-12-13 13:42:54 +01:00
committed by Kai Zimmermann
parent 59da4dbfb1
commit 4691340e6a
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@@ -7,7 +7,7 @@ Jekyll is a ruby gem and needs ruby to execute.
## Unix / Mac
On a unix or mac you don't need to extra install Jekyll. The maven build is downloading the ruby runtime and the necessary ruby-gems via the maven rubygems-proxy repository. The ruby runtime is downloaded into the `target` folder and executed during the build.
To serve the current documentation you only need to call `mvn gem:exec@jekyll-serve`. It automatically monitors the filesystem and every local changes are generated on-demand on the local server [http://127.0.0.1:4000/](http://127.0.0.1:4000/).
To serve the current documentation you only need to call `mvn install gem:exec@jekyll-serve`. It automatically monitors the filesystem and every local changes are generated on-demand on the local server [http://127.0.0.1:4000/](http://127.0.0.1:4000/).
## Windows
On a windows operating system you'll need to install Jekyll manually. If you don't have installed Jekyll on your machine you can just use the [PortableJekyll](https://github.com/madhur/PortableJekyll) project. Just clone the Github repository and start the `setpath.cmd` which setups the necessary path entries into the CMD (Don't forget to copy them into the environment path variable to have the path set for every command prompt).