In contrast to Docs, Tutorials provide more detailed, narrative instruction that cover a variety of Jekyll topics and scenarios. Tutorials might contain the following:
- Step-by-step processes through particular scenarios or challenges
- Full walk-throughs using sample data, showing inputs and results from the sample data
- Detailed explanation about the pros and cons for different Jekyll strategies
- End-to-end instruction in developing a complete feature on a Jekyll site
- Instruction that combines various techniques from across the docs
In short, tutorials aren’t the core reference information in docs. They walk users through processes from beginning to end.
Note: The Tutorials section is new, so there aren’t many tutorials yet. You can add a tutorial here to help popular this section.
Some of these techniques might even guide you through a supporting tool, script, service, or other hack used with your Jekyll site. Feel free to include tutorials involving external services with Jekyll as well. However, note that Jekyll in no way endorses any third-party tools mentioned in tutorials.
How to contribute a tutorial
We welcome your tutorial contributions. To add your tutorial:
- Fork the Jekyll project by clicking the Fork button in the upper-right corner of the jekyll/jekyll project Github repo.
- Add your tutorial in the
- Make sure your tutorial has the same front matter items as other tutorial items.
- Add a reference to your tutorial filename in
_data/tutorials.yml. This allows your tutorial to appear in the Tutorials sidebar.
- Follow the regular git workflow to submit the pull request.
When you submit your pull request, the Jekyll documentation team will review your contribution and either merge it or suggest edits.