Code Monkey home page Code Monkey logo

jekyll-sheafy's Introduction

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.

Node variables

TODO: fill in details for each variable.

General

  • taxon

Layouting

  • layout
  • sublayout

Dependencies

  • ancestors
  • parent
  • subroot
  • children

References

  • referrers

Numbering

  • clicker
  • clicks

Roadmap

These are the features you can expect in the future:

  • Enable referents variable w/ nodes references by the current one
  • root variable w/ root node of the tree
  • siblings variable or some variant of it to enable navigation between adjacent nodes at the same depth
  • Prev/next node navigation
  • Variable inheritance from parent/root node
  • 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.

jekyll-sheafy's People

Contributors

paolobrasolin avatar jonsterling avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.