Project

jekyll-sheafy

0.0
There's a lot of open issues
No release in over a year
jekyll-sheafypaolobrasolin/jekyll-sheafyHomepageDocumentationSource CodeBug TrackerWiki
This Jekyll plugin is heavily inspired by Gerby, the tool used to build the Stacks Project and Kerodon. It allows you to build math textbooks as static websites which require no complex infrastructure to run.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
3,428
Stars
9
Forks
1
Watchers
5
 Releases
Current version
0.3.0
Total releases
3
First release
2022-01-28
Latest release
2022-01-31
 Issues
Open Issues
8
Closed Issues
2
Total Issues
10
Issue Closure Rate
20%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
3
Pull Request Acceptance Rate
75%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2022-01-29
Reverse Dependencies
0

 Dependencies

Development

byebug
~> 11.1.3
rspec
~> 3.10.0
rufo
~> 0.13.0
simplecov
~> 0.21.2
guard
~> 2.18.0
guard-rspec
~> 4.7.3
simplecov-lcov
~> 0.8.0

Runtime

jekyll
>= 3, < 5
 Project Readme

jekyll-sheafy

CI tests status badge Latest release badge License badge Maintainability badge Test coverage badge

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.