Jekyll Github Cheat Sheet

From WikiOD

Here is the cheatsheat of Jekyll Github and basic guide on how to use Jekyll Github {% raw %}

Jekyll[edit | edit source]

{: .-one-column}

  • jekyll-avatar
  • jekyll-coffeescript
  • jekyll-default-layout
  • jekyll-feed
  • jekyll-gist
  • jekyll-github-metadata
  • jekyll-mentions
  • jekyll-optional-front-matter
  • jekyll-paginate
  • jekyll-readme-index
  • jekyll-redirect-from
  • jekyll-relative-links
  • jekyll-sass-converter
  • jekyll-seo-tag
  • jekyll-sitemap {: .-four-column}

As of github-pages v156. For an updated list, see: Dependency versions (pages.github.com)

GitHub Metadata[edit | edit source]

Configuration[edit | edit source]

plugins:
  - jekyll-github-metadata

repository: username/project

Put this in your _config.yml. See: Repository metadata on GitHub pages

Listing repos[edit | edit source]

{% for repository in site.github.public_repositories %}
  <a href='{{ repository.html_url }}'>
    {{ repository.name }}
  </a>
{% endfor %}

Link to repo[edit | edit source]

<a href='{{ site.github.repository_url }}'>
  {{ site.github.project_title }}
</a>

Gists[edit | edit source]

Configuration[edit | edit source]

plugins:
  - jekyll-gist

See: jekyll-gist

Usage[edit | edit source]

{% gist parkr/c08ee0f2726fd0e3909d %}

This places a Gist in your page.

Mentions[edit | edit source]

Configuration[edit | edit source]

plugins:
  - jekyll-mentions

See: jekyll-mentions

Usage[edit | edit source]

Hey @rstacruz, what do you think of this?

Just mention anyone in any page. Their names will be turned into links.

Redirects[edit | edit source]

{: .-three-column}

Configuration[edit | edit source]

plugins:
    - jekyll-redirect-from

See: jekyll-redirect-from

Usage[edit | edit source]

---
redirect_from:
  - /foo
---

Place on any page.

Redirecting[edit | edit source]

---
redirect_to:
  - /foo
---

Place on any page. See: redirect to

{% endraw %}

Credit:rstacruz