Developer Documentation & Community
1 - Learn Jekyll
-
Jekyll Introduction
The Jekyll introduction outlines specifically what Jekyll is and why you would want to use it, as well as exactly how Jekyll does what it does.
-
Template Data Api
The Template data API is a comprehensive list of all data accessible in templates via the Liquid templating language.
-
Jekyll Liquid Api
The Liquid API gets us up to speed with the syntax, methods, and logic needed to build templates and interact with our data structures.
2 - Learn Jekyll Bootstrap
-
Jekyll Bootstrap API
The Bootstrap API documents all method calls available to your blog when using the JB framework.
-
Theme API
The Theme API makes it possible for users and/or designers to create and publish modular themes that plug right into Jekyll Bootstrap.
3 - Contribute
Community
Please help spread the word about Jekyll Bootstrap. Also your usage feedback is very much needed and appreciated.
Themes
Please consult the Theme API section to learn how to create and update themes.
Themes are tracked and published on the GitHub Jekyll-Bootstrap Project Page. To update an existing theme please send pull requests to the theme's repository.
Javascript Plugins
If you are good at javascript we can work together to figure out a definitive client-side plugin strategy for Jekyll. This is really important because since GitHub pages can't support liquid/jekyll plugins, we can still code robust functionality via javascript.
Core Jekyll/Liquid API
This is the core JB framework which interacts with Liquid and Jekyll. If you are good at ruby and/or Liquid, consider improving the rake tasks or JB helpers.
Documentation
More content, tutorials information is welcome. You can also proofread existing materials.
How
Jekyll Bootstrap is on GitHub.
Send pull requests as outlined in the main README file.
Features, bugs, and questions should be entered as GitHub Issues.
Why
Jekyll Bootstrap's technical objective is to create a standardized, well-tuned API for creating and maintaining Jekyll-powered blogs. This will provide users with an easy way to contribute their work to a growing community.
If you are interested in making technical blogging better, not only for yourself, but for others around the world, consider contributing to Jekyll Bootstrap - we are glad to have you!
License
Unlicense - Jekyll Bootstrap is released into the Public Domain.
It should also be noted that by willingly submitting any updates to the project, you are accepting the Unlicensing Policy and setting your code Free into the Public Domain =)
Thank you.
