* spelling: always Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: apostrophe Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: articles Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: bajillion Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: bandwidth Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: compatibilize Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: congratulations Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: consistent Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: containing Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: correspondents Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: debuggability Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: definitions Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: engine Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: expectations Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: framework Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: gallery Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: github Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: gitlab Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: hesitant Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: hesitate Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: highlighter Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: installation Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: internal Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: kramdown Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: link Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: markdown Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: markdownify Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: metadata Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: multiple Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: object Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: overridden Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: paths Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: positions Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: powershell Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: proceeding Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: pygments settings Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: referencing Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: retrieve Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: separating Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: several Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: specific Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: suppress Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: upgrading Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: variable Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: variables Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: whitespace Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: with Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
1.9 KiB
title, permalink, redirect_from
| title | permalink | redirect_from |
|---|---|---|
| Tutorials | /tutorials/home/ | /tutorials/index.html |
In contrast to [Docs]({{ '/docs/home/' | relative_url }}), 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 .info} The Tutorials section is new, so there aren't many tutorials yet. You can add a tutorial here to help populate 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
_tutorialscollection. - 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.