This repository has been archived by the owner. It is now read-only.
Picnic is a gorgeous documentation template for Jekyll
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes
_layouts
.editorconfig
.gitignore
LICENSE.md
README.md
_config.yml
scripts.js
search.json
styles.css

README.md

Picnic

Picnic is a gorgeous documentation template for Jekyll

Picnic is a documentation template for Jekyll that came to life out of the need of having a simple and elegant way to write, view, and search documentation for projects of all sizes.

Picnic is heavily inspired by existing projects such as Slate, Daux.io, and Docco. However, unlike these projects, Picnic is fully compatible with Jekyll-based GitHub Pages and can therefore be hosted without needing to be built beforehand.

Perhaps best of all, Picnic features full-text search using lunr.js. The search data is asynchronously streamed and indexed in chunks using Oboe.js, so even if you have hundreds of pages it won't slow down your docs.

Watch Picnic in action

License

Copyright © 2014-2016 Kasper Kronborg Isager. Licensed under the terms of the MIT license.