Widgets
Info
- File _includes/widgets/info.html
- Render a list of liquid parameters for the host page and the repository.
info example
{% include widgets/info.html %}
- Page
- url: https://riminino.github.io/docs/widgets/
- link on GitHub: https://github.com/riminino/riminino.github.io/blob/master/_docs/widgets.md
- environment:
dotcom - title:
Widgets - name: ``
- url:
/docs/widgets/ - path:
_docs/widgets.md - dir: ``
- Repository
- repository_nwo: riminino/riminino.github.io
- homepage: https://riminino.github.io
- default_branch:
master - language:
JavaScript - size:
88
- Version
- build_revision:
faa4303 - updated_at:
Sat, 09 Nov 2019 17:27:44 +0000 - tag_name: ``
- name: ``
- draft: ``
- prerelease: ``
- build_revision:
- Type
- is_user_page:
true - is_project_page:
false - fork:
false
- is_user_page:
- GitHub
- organization_members size:
0 - contributors:
1 - forks_count:
0 - stargazers_count:
0
- organization_members size:
- Remote theme
- repository: ``
Unslug
- File _includes/widgets/unslug.html
- Replace dashes and underscores with space and capitalize first word.
| Parameter | Type | Description | Initial |
|---|---|---|---|
include.string |
string | The string to unslug | hello_world |
unslug example
{% include widgets/unslug.html %}
Hello world
Github url
- File _includes/widgets/github_url.html
- Return the url on GitHub of the passed file.
| Parameter | Type | Description | Initial |
|---|---|---|---|
include.file |
string | Path of the file | page.path |
github_url example
{% include widgets/github_url.html %}
https://github.com/riminino/riminino.github.io/blob/master/_docs/widgets.md
Github link
- File _includes/widgets/github_link.html
- Render the HTML link on GitHub of the passed file
| Parameter | Type | Description | Initial |
|---|---|---|---|
include.file |
string | Path of the file | page.path |
include.complete |
boolean | true show absolute link, nil show relative link |
nil |
Datetime
- File _includes/widgets/datetime.html
- Render a span element with
datetimeattribute. - If _includes/scripts/datetime.coffee is included show elapsed time or time ago on mouseover.
| Parameter | Type | Description | Initial |
|---|---|---|---|
include.datetime |
string | Date to render | nil |
include.embed |
boolean | If true append elapsed time or time ago to the text |
nil |
include.replace |
boolean | If true replace the text with elapsed time or time ago |
nil |
datetime example
{% include widgets/datetime.html %}
Sat, 09 Nov 2019 17:27:49 +0000
Commits
- File _includes/widgets/commits.html
- Render the list of commits as a table.
- Optional filters for author and path.
- Require _includes/scripts/commits.coffee.
| Parameter | Type | Description | Initial |
|---|---|---|---|
include.details |
boolean | Render the table inside a expandible details element |
nil |
include.path |
string | Fetch commits only for the specified path | nil |
include.author |
string | Fetch commits only for the specified author | nil |
commits example
{% include widgets/commits.html %}
| Message | Author | Comments | Date |
|---|
Releases
- File _includes/widgets/releases.html
- Render the list of releases as a table.
- Require _includes/scripts/releases.coffee.
| Parameter | Type | Description | Initial |
|---|---|---|---|
include.details |
boolean | Render the table inside a expandible details element |
nil |
releases example
{% include widgets/releases.html %}
| Draft | Name | Body | Date |
|---|