Skip to content

Add how to install jekyll #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Phu2 merged 2 commits into from
May 13, 2025
Merged

Add how to install jekyll #56

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d19f1d0
Add how to install jekyll
dr0i Apr 29, 2025
411d036
Improve installation guide
dr0i May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,26 @@ For the documentation see: http://metafacture.github.io/metafacture-documentatio

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).

The content pages can be found [here in `/docs/`](/docs/)

The content pages can be found [in `/docs/`](/docs/)

## Installation
If you are on debian derivates go install build-essentials:
```
apt install build-essential
Copy link
Collaborator

@TobiasNx TobiasNx Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the whitespace intentional?

Copy link
Member Author

@dr0i dr0i Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I thought so because here it is also one prefixing whitespace: https://github.com/metafacture/metafacture-documentation/blob/master/docs/Documentation-Maintainer-Guide.md?plain=1#L33C1-L34C2 , but at other places it is not. We can or should remove all prefixing whitespaces?

Copy link
Member Author

@dr0i dr0i May 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed these whitespaces here.

```
Then you can use the Ruby Dependency Management to build all you need:
```
bundle install jekyll
bundle install
```
Start jekyll like this:
```
bundle exec jekyll serve
```

## Note
> [!NOTE]
> 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/).

> 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/).

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.