jekyll-sheafy

jekyll-sheafy is a Jekyll plugin inspired by Gerby which allows you to setup websites similar to the Stacks project and Kerodon.

Getting started

Currently, the state of the art in using jekyll-sheafy is represented by The Nursery. Until I write a minimal guide, the bes way to get started is forking it and playing around with it.

Usage

TODO: general usage notes.

Architecture

TODO: explain the Directed Rooted Forest structure and the taxa mechanism.

Configuration

TODO: fill in details for each parameter.

sheafy:
  references:
    matchers: [] # ...
  taxa: {} # ...
  inheritable: [] # ...

Node variables

TODO: fill in details for each variable.

General

• taxon

Layouting

• layout
• sublayout

Dependencies

• root
• ancestors
• parent
• subroot
• children
• predecessors
• successors

References

• referrers
• referents

Numbering

• clicker
• clicks

Roadmap

These are the features you can expect in the future:

• Search feature

Of course any feedback is welcome!

Acknowledgements

• Thanks to @jonsterling for
  • using krater to setup The Nursery,
  • having the "brew your own Kerodon" idea, and
  • letting me collaborate to spin it off into jekyll-sheafy.