Skip to content

Commit d19f1d0

Browse files
committed
Add how to install jekyll
1 parent 6d2ee7a commit d19f1d0

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,26 @@ For the documentation see: http://metafacture.github.io/metafacture-documentatio
77

88
This repo is the central place for the documentation about Metafacture that we render using the jekyll template [Just the docs](https://github.com/just-the-docs/just-the-docs).
99

10-
The content pages can be found [here in `/docs/`](/docs/)
11-
10+
The content pages can be found [in `/docs/`](/docs/)
11+
12+
## Installation
13+
If you are on debian derivates go install build-essentials:
14+
```
15+
apt install build-essential
16+
```
17+
Then you can use the Ruby Dependency Management to build all you need:
18+
```
19+
bundle install jekyll
20+
bundle install
21+
```
22+
Start jekyll like this:
23+
```
24+
bundle exec jekyll serve
25+
```
26+
27+
## Note
1228
> [!NOTE]
13-
> With regard to the Transformation-Modules this documentation focusses on Fix instead of MORPH. If you want to find out more about MORPH. Have a look at [the old documentation](https://github.com/metafacture/metafacture-core/wiki/Metamorph-User-Guide) and the german cookbook by [Swissbib](https://swissbib.gitlab.io/metamorph-doku/).
14-
29+
> With regard to the Transformation-Modules this documentation focusses on Fix instead of Morph. If you want to find out more about Morph have a look at [the old documentation](https://github.com/metafacture/metafacture-core/wiki/Metamorph-User-Guide) and the german cookbook by [Swissbib](https://swissbib.gitlab.io/metamorph-doku/).
1530
1631
Our goal with this repo is to collaboratively create comprehensive documentation on Metafacture in the [issue tracker](https://github.com/metafacture/metafacture-documentation/issues?q=). Feel free to open issues not only for bugs or enhancements, but also questions about Metafacture usage, or to share your experiences. We hope that over time, in that way we can create useful tutorials, how-tos, and collect good practices for using Metafacture.
1732

0 commit comments

Comments
 (0)