Document keys of the `theme` drop

Follow-up to #9129
This commit is contained in:
Ashwin Maroli 2022-09-25 20:23:04 +05:30
parent 6633fd2335
commit d09c5105d7
3 changed files with 23 additions and 1 deletions

View File

@ -16,6 +16,10 @@ global:
description: >- description: >-
Layout specific information + the <a href="/docs/front-matter/">front matter</a>. Layout specific information + the <a href="/docs/front-matter/">front matter</a>.
Custom variables set via front matter in layouts will be available here. Custom variables set via front matter in layouts will be available here.
- name: theme
description: >-
Theme-gem specific information as defined in the theme's gemspec. Useful for rendering
information in the theme demo's "About" page, for example. See below for details.
- name: content - name: content
description: >- description: >-
In layout files, the rendered content of the Post or Page being wrapped. In layout files, the rendered content of the Post or Page being wrapped.
@ -150,6 +154,20 @@ page:
The previous post relative to the position of the current post in <code>site.posts</code>. The previous post relative to the position of the current post in <code>site.posts</code>.
Returns <code>nil</code> for the first entry. Returns <code>nil</code> for the first entry.
theme:
- name: theme.root
description: Absolute path to the theme-gem.
- name: theme.authors
description: Comma separated string composed of the authors of the theme-gem.
- name: theme.description
description: Description or summary of the theme-gem as specified in the theme gemspec.
- name: theme.version
description: The version string of current theme.
- name: theme.dependencies
description: List of runtime dependencies of the theme.
- name: theme.metadata
description: A mapping of key-value pairs as defined in the theme gemspec.
paginator: paginator:
- name: paginator.page - name: paginator.page
description: The number of the current page description: The number of the current page

View File

@ -34,6 +34,10 @@ The following is a reference of the available data.
</p> </p>
</div> </div>
## Theme
{% include docs_variables_table.html scope=site.data.jekyll_variables.theme %}
## Paginator ## Paginator
{% include docs_variables_table.html scope=site.data.jekyll_variables.paginator %} {% include docs_variables_table.html scope=site.data.jekyll_variables.paginator %}

View File

@ -3,7 +3,7 @@
module Jekyll module Jekyll
module Drops module Drops
class ThemeDrop < Drop class ThemeDrop < Drop
delegate_methods :root, :version delegate_methods :root
delegate_method_as :runtime_dependencies, :dependencies delegate_method_as :runtime_dependencies, :dependencies
def authors def authors