Skip to content
Static site generator in Haskell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
bin
examples
nix/ghc-8.2
src
test
.gitignore
.travis.yml
CHANGELOG.md
DEVELOPMENT.md
LICENSE
Makefile
README.md
Setup.hs
default.nix
hie-start.sh
pencil.cabal
pencil.nix
release-ghc-8.2.nix
release-ghc-8.4.nix
release-ghc-8.6.nix
release.nix
stack-ghc-8.0.yaml
stack-ghc-8.2.yaml
stack-ghc-8.4.yaml

README.md

CircleCI

Pencil

Pencil is a static site generator. Use it to generate your personal website! Pencil comes pre-loaded with goodies such as blogging, tagging, templating, and Markdown Sass/Scss support. Flexible enough to extend for your own needs.

The easiest way to get started is to read the tutorials at elbenshira.com/pencil and reference the Haddock docs.

The blue-backed notebooks, the two pencils and the pencil sharpener... the marble topped tables, the smell of early morning... and luck were all you needed. — Ernest Hemingway, A Moveable Feast

Setup

First, make sure you have nix installed:

curl https://nixos.org/nix/install | sh
nix-channel --add https://nixos.org/channels/nixos-18.09 nixpkgs
nix-channel --update

Examples

Checkout the examples provided. To run the Simple example:

nix-shell --attr env
[nix-shell]$ cabal new-run pencil-example-simple

Open the examples/Simple/out/ folder to see the rendered web pages. To serve the web pages (so that relative URLs work), using python's built in web server is easiest:

cd examples/Simple/out/
python -m SimpleHTTPServer 8000

And go to localhost:8000.

Development

See DEVELOPMENT.md

You can’t perform that action at this time.