Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.96 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.96 KB
Raw

Omidyar Kenya Report

Structure

Functions

[There are some Jekyll includes that serve as functions]

Figures

{% include figure.html src="[the source, without site.baseurl]" %}

The figure function takes these parameters:

  • src (required; should be used without {{ site.baseurl }}, but takes a leading /)
  • class (optional)
  • alt (optional)
  • caption (optional)
  • source (optional)

Figures can be used without a class, or with:

  • .fullWidth
  • .floatLeft (TBD)
  • .floatRight (TBD)

Fly-Out Features

Throughout the report there are links to features, case studies, etc. that are separate from the narrative of the report. These features use the flyOut.html include, and pass in the Markdown file like this:

Include content as a variable

{% capture variableName %}{% include /content/0.0.1_variableName.md %}{% endcapture %}

Markdownify the variable

{% capture variableName %}{{ variableName | markdownify }}{% endcapture %}

Include the flyOut function and pass in a title, and the variable content

{% include flyOut.html type="Case Study:" title="A Closer Look At Fly-Out Features" content=variableName %}

Navigation

_data/navigation.yml is used to control the site's navigation. The top-level navigation, and sub-section navigation is managed in the same way. Sub-section URLs should point to the named anchor tags within each section's Markdown file.

Lazy Loading

Images can be lazy-loaded via Lozad.js. Add the lozad class to an image, and replace src with data-src. It's that easy.

Contributing

Bug reports and pull requests are welcome on GitHub.

License

This report is distributed with a Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Creative Commons Attribution-ShareAlike 4.0 International logo