1
1
mirror of https://github.com/srid/rib.git synced 2024-11-30 03:45:00 +03:00
Haskell static site generator based on Shake (superseded by Ema)
Go to file
2019-08-03 09:24:37 -04:00
examples Finish invoice generator example 2019-08-03 09:24:37 -04:00
src/Rib Finish invoice generator example 2019-08-03 09:24:37 -04:00
.gitignore Vastly simplify configuration (#19) 2019-07-14 11:17:48 -04:00
default.nix doc: Include example's Main.hs dynamically 2019-07-19 16:42:18 -04:00
ghcid Add hierarchy info to docs (#21) 2019-07-16 19:47:14 -04:00
README.md Add support for non-Markdown formats 2019-07-23 16:46:04 -04:00
rib.cabal Add WIP invoice generator example (#26) 2019-07-23 07:48:29 -04:00

rib

Rib is a static site generator written in Haskell that reuses existing tools (Shake, Lucid and Clay) and is thus non-monolithic. It is nearly done but still a work in progress and will soon be ready for general use.

Example

See ./examples/hello-world to see how the Rib library can be used to write your own static site generator in a few lines of code which includes the HTML and CSS of the site.

See ./examples/doc for a real-world example---Rib's own documentation site.

(Refer to Rib.Simple if you need further customization of the Shake action.)

With Rib you do not have to deal with less powerful template engines or write raw HTML/CSS by hand. Do everything in Haskell, and concisely at that!


To get an example site up and running run:

cd ./examples/hello-world
../../ghcid

This will:

  • Drop into a nix-shell with needed Haskell dependencies
  • Compile the rib library and Main.hs through ghcid
    • Whenever Haskell sources change ghcid reloads them
  • Run Main.hs:buildAction (as if with serve -w CLI arguments)
  • This does the following:
    1. Convert sources in ./a into ./b using Shake
    2. Listens for changes to ./a, and re-generate them (i.e., the -w argument)
    3. Start a HTTP server serving the ./b directory (i.e, the serve command)

Thus, by running that one command one gets a production-quality web server serving the statically generated HTML files which automatically get regenerated when the source content changes. What's more, we may change the Haskell sources such as Main.hs and ghcid will recompile and relaunch the whole thing.

With rib we get hot reload for free.

Use cases

  • Website / Blog generation
  • Documentation
  • Org Mode interface
  • Invoice generation