Skip to content

Lips/picnic

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Picnic

Release

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

Picnic in the wild

  • Vanilla Forums
    API, developer, and end-user documentation for Vanilla Forums. This is where Picnic was born!

Copyright 2014 © Kasper Kronborg Isager. Licensed under the terms of the MIT License

Packages

No packages published

Languages

  • CSS 62.5%
  • JavaScript 21.3%
  • HTML 16.2%