Skip to content

Commit

Permalink
add jekyll installation process for Mac OS to README.md;
Browse files Browse the repository at this point in the history
adapt basic-metadata.md docu;

Signed-off-by: Stefan <stefan.maute@bosch.io>
  • Loading branch information
Stefan committed Aug 2, 2022
1 parent 90bfddd commit c87b078
Show file tree
Hide file tree
Showing 2 changed files with 246 additions and 91 deletions.
12 changes: 9 additions & 3 deletions documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ mvn clean install -Pbuild-documentation

In order to edit the documentation

#### Alternative 1: install Jekyll (UNIX)
#### Alternative 1: install Jekyll (UNIX or Mac OS)

##### Unix
Use that if you are on a UNIX system (or have the Ubuntu bash subsystem for Windows 10).
If you're behind a proxy, you can use the `http_proxy` parameter.

Expand All @@ -33,6 +34,10 @@ If the installation of html-proofer fails, you may need the additional build dep
sudo apt install zlib1g-dev
```

##### Mac OS
Follow the steps described in the link to install [Jekyll on macOS](https://jekyllrb.com/docs/installation/macos/)

###### Watch resources
Watch all resources and start local server serving the Jekyll content at [http://localhost:4000](http://localhost:4000):

```bash
Expand All @@ -55,8 +60,9 @@ It automatically monitors the filesystem and every local changes are generated o
#### Alternative 3: use Maven (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).
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).

The maven build on windows just executes the Jekyll process using the maven-exec plugin. This allows to also use maven build to build and serve the documentation on a windows machine.
The maven build on Windows just executes the Jekyll process using the maven-exec plugin. This allows to also use maven build to build and serve the documentation on a windows machine.

To serve the current documentation you only need to call `mvn exec:exec@jekyll-serve`. It automatically monitors the filesystem and every local changes are generated on-demand on the local server [http://localhost:4000](http://localhost:4000).

Loading

0 comments on commit c87b078

Please sign in to comment.