Skip to content

Commit beed42e

Browse files
authored
Merge pull request #56 from metafacture/addHowToInstallJekyll
Add how to install jekyll
2 parents 6d2ee7a + 411d036 commit beed42e

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,30 @@ 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
20+
```
21+
Start jekyll like this:
22+
```
23+
bundle exec jekyll serve
24+
```
25+
If you experience troubles, make sure to not have jekyll installed via you
26+
package manager. On debian derivates do:
27+
```
28+
apt purge jekyll
29+
```
30+
31+
## Note
1232
> [!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-
33+
> 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/).
1534
1635
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.
1736

0 commit comments

Comments
 (0)