diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 42 |
1 files changed, 5 insertions, 37 deletions
@@ -1,41 +1,9 @@ -# estatico +# estático - static website generator -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. +This is my minimalistic static website generator coded in **Haskell**. +It uses **pandoc** et al. for some of the heavy work. -## features +Consult the project page for details: -* 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 +* <https://www.idziorek.net/blog/Haskell/Estatico-Page-Maker/> |