diff options
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | README.md | 42 | ||||
| -rw-r--r-- | estatico.cabal (renamed from staticus.cabal) | 10 |
3 files changed, 12 insertions, 42 deletions
diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..2eed15c --- /dev/null +++ b/Makefile @@ -0,0 +1,2 @@ +update_gitweb_readme: + markdown README.md | ssh git readme miguel/estatico set @@ -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/> diff --git a/staticus.cabal b/estatico.cabal index 7fae162..c16e424 100644 --- a/staticus.cabal +++ b/estatico.cabal @@ -1,6 +1,6 @@ cabal-version: 1.12 -name: staticus +name: estatico version: 0.1.0.0 description: Check README.md author: Michal Idziorek @@ -18,7 +18,7 @@ library WWWStaticus WWWStaticusPlugins other-modules: - Paths_staticus + Paths_estatico hs-source-dirs: src build-depends: @@ -36,14 +36,14 @@ library , bytestring default-language: Haskell2010 -executable staticus-exe +executable estatico-exe main-is: Main.hs other-modules: - Paths_staticus + Paths_estatico hs-source-dirs: app ghc-options: -threaded -rtsopts -with-rtsopts=-N build-depends: base >=4.7 && <5 - , staticus + , estatico default-language: Haskell2010 |