summaryrefslogtreecommitdiff
path: root/README.md
blob: 4d03cc12dcfeb2c4171547a97959076d5c39668e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# estatico

This is a simple static website generator coded in Haskell.
It uses pandoc for the heavy work, as syntax highlighting and parsing 
of the markdown files.

## features

* No Database
* Only Static Content
* Sitemap derived from Directory Tree
* Simple Markdown Files

# gitweb

https://github.com/miguelclean/estatico

# dockerhub

https://hub.docker.com/r/migueldirty/estatico/builds

# example usage

__NOTE: make sure DIR\_OUT exists and is a free directory__

You can use the example websites inside the examples/ directory for a start.

Inside the input directory (e.g. ./examples/example01/) run something along this lines:

    DIR_IN=`pwd`
    DIR_OUT=/mnt/yourwebsiteroot
    HTML_ROOT=https://www.example.com
    SUDO=sudo
    IMAGE=migueldirty/estatico
    ${SUDO} docker run --rm -v${DIR_IN}:/in:ro -v${DIR_OUT}:/out:rw ${IMAGE} /in /out ${HTML_ROOT}

Or if you want to test it locally use some local DIR\_OUT and HTML\_ROOT instead:

    DIR_OUT=/home/miguel/testpage
    HTML_ROOT=/home/miguel/testpage