Hackage :: [Package]

pencil: Static site generator

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

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

[Skip to Readme]

Properties

Versions 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 1.0.0, 1.0.1
Change log CHANGELOG.md
Dependencies base (>=4.8 && <5), data-default (>=0.7 && <1), directory (>=1.2.5.0 && <1.4), edit-distance (>=0.2.2.1 && <0.3), filepath (>=1.4 && <1.5), hashable (>=1.2.6.0 && <1.3), hsass (>=0.8 && <1), mtl (>=2.2 && <3), pandoc (>=2.0 && <3), parsec (>=3.1 && <3.2), semigroups (>=0.18.2 && <0.19), text (>=1.2.2 && <1.3), time (>=1.5.0.1 && <1.9), unordered-containers (>=0.2.7.2 && <0.3), vector (>=0.12.0 && <0.13), xml (>=1.3.10 && <1.4), yaml (>=0.8.32 && <0.12) [details]
License BSD-3-Clause
Copyright 2018 Elben Shira
Author Elben Shira
Maintainer elbenshira@gmail.com
Category Web
Home page https://github.com/elben/pencil
Source repo head: git clone https://github.com/elben/pencil
Uploaded by elben at 2019-01-28T18:27:05Z

Modules

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Readme for pencil-0.1.4

[back to package description]

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