README.md 1.15 KB
Newer Older
Nicolas Lenz's avatar
Nicolas Lenz committed
1
2
![Nebelhorn logo](logo/logo.svg)

Nicolas Lenz's avatar
Nicolas Lenz committed
3
# Nebelhorn
Software's avatar
Software committed
4

Nicolas Lenz's avatar
Nicolas Lenz committed
5
A flexible static website generator using [Pandoc](https://pandoc.org), written in Haskell. Still very much work in progress and changing fast, but it's already usable.
Nicolas Lenz's avatar
Nicolas Lenz committed
6
7

For an example of what it can do, take a look at [my blog](https://www.eisfunke.com).
Nicolas Lenz's avatar
Nicolas Lenz committed
8
9
10
11
12
13
14
15
16
17
18
19


## Usage

The usage of Nebelhorn is documented in the [wiki](https://git.eisfunke.com/software/nebelhorn/wikis/home).


## Installation

To build Nebelhorn yourself all you need is a working [Stack](https://docs.haskellstack.org/en/stable/README/) installation.

Then clone or download this repository and run `stack install` in the repo folder. This will build Nebelhorn and install it as `.local/bin/nebelhorn`.
Nicolas Lenz's avatar
Nicolas Lenz committed
20

Nicolas Lenz's avatar
Nicolas Lenz committed
21
Alternatively download the latest binary [here](https://git.eisfunke.com/software/nebelhorn/-/jobs/artifacts/main/raw/nebelhorn?job=build). It has no dependencies except glibc, so it should run out-of-the-box on most Linux systems (not Alpine).
Nicolas Lenz's avatar
Nicolas Lenz committed
22

Nicolas Lenz's avatar
Nicolas Lenz committed
23
24
Official packages or container are not yet available, but planned.

Nicolas Lenz's avatar
Nicolas Lenz committed
25

Nicolas Lenz's avatar
Nicolas Lenz committed
26
27
28
## Contribution

If you discover any bugs, or if you have comments or feature ideas, please do open an issue or even submit a merge request.