pencil: Static site generator

[ bsd3, library, web ] [ Propose Tags ]

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.


[Skip to Readme]
Versions [faq] 0.1.0, 0.1.1, 0.1.2, 0.1.3, 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), feed (>=0.3.12.0 && <1), filepath (==1.4.*), hashable (>=1.2.6.0 && <1.3), hsass (>=0.4.0 && <0.5), mtl (>=2.2 && <3), pandoc (>=1.19.2.4 && <2), parsec (==3.1.*), pencil, 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.23 && <0.9) [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 Thu Feb 1 03:34:37 UTC 2018
Distributions NixOS:1.0.1, Stackage:1.0.1
Executables pencil-example-blog, pencil-example-simple
Downloads 750 total (65 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2018-02-01 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for pencil-0.1.1

[back to package description]

Build Status

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 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

Examples

Checkout the examples provided. To run the Simple example:

stack build
stack exec 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

stack build --pedantic
stack test
stack exec doctest src/

Documentation

stack haddock

Ctags

stack install hasktags
hasktags --ignore-close-implementation --ctags .

Release

Make sure it builds, passes tests, and works:

stack build
stack test
stack exec pencil-example-simple
stack exec pencil-example-blog
stack haddock

Check that tutorials are updated.

Update the CHANGELOG.md.

Update the version number in pencil.cabal.

Commit the changes.

Tag the release:

git tag v0.1.0
git push --tags

Push to Hackage:

stack sdist
stack upload

Travis CI

travis-ci.org/elben/pencil

Note that .travis.yml was generated using multi-ghc-travis this:

stack exec runghc ~/code/multi-ghc-travis/make_travis_yml_2.hs pencil.cabal > .travis.yml