Skip to content

Provide complete list of variables for maintainer reference #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Provide complete list of variables for maintainer reference #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion guides/maintainer_guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,16 @@ Into every page, AsciiBinder passes the following variables:
The full path to the repo `_templates` directory, for invoking other templates from `page.html.erb`.
`site_home_path`::
The complete relative path to the site homepage, including `index.html`.
`breadcrumb_root`::
Root element for breadcrumb
`breadcrumb_group`::
Current group for breadcrumb
`breadcrumb_topic`::
Current topic for breadcrumb
`breadcrumb_subgroup_block`::
HTML with ctive list item of the breadcrumb_subgroup, `<li class="hidden-xs active">#{args[:breadcrumb_subgroup]}</li>`
`subtopic_shim`::
Path to parent topic, specifically `../`

These values can be used to supply topic content, navigational controls and other dyanmic page elements.

Expand Down Expand Up @@ -342,4 +352,3 @@ The process is:
. Use `git cherry-pick <commit_id>` to add the change to the version branch

Depending on the scope of the change and the differences between the version branch and the master branch, attempting the cherry-pick may cause a merge collision. In this instance, it may be easier to submit the correction as a new, separate pull request against the version branch.