328476b45b
Demonstrate this by using reST in examples/hello-world, at the expense of relinquishing yaml metadata (which is markdown-only), which is however retained in examples/doc.
1.9 KiB
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
riblibrary andMain.hsthrough ghcid- Whenever Haskell sources change ghcid reloads them
- Run
Main.hs:buildAction(as if withserve -wCLI arguments) - This does the following:
- Convert sources in
./ainto./busing Shake - Listens for changes to
./a, and re-generate them (i.e., the-wargument) - Start a HTTP server serving the
./bdirectory (i.e, theservecommand)
- Convert sources in
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