rocksdb/docs/index.md
Joel Marcey ea9e0757ff Add initial GitHub pages infra for RocksDB documentation move and update. (#1294)
This is the initial commit with the templates necessary to have our RocksDB user documentation hosted on GitHub pages.

Ensure you meet requirements here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements

Then you can run this right now by doing the following:

```
% bundle install
% bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml
```

Then go to: http://127.0.0.1:4000/

Obviously, this is just the skeleton. Moving forward we will do these things in separate pull requests:

- Replace logos with RocksDB logos
- Update the color schemes
- Add current information on rocksdb.org to markdown in this infra
- Migrate current Wodpress blog to Jekyll and Disqus comments
- Etc.
2016-08-24 15:35:38 -07:00

49 lines
1.5 KiB
Markdown

---
layout: home
title: Example - You can over-ride the default title here
id: home
---
## Gridblocks
You can use the gridblocks sub-template to arrange information into nice responsive grids. There are two ways to add a grid block, the first is by adding a yml file to the `_data` folder and then using it as a data source:
{% include content/gridblocks.html data_source=site.data.features align="center" %}
The second is simply to use the raw HTML of the grid blocks:
<div class="gridBlock">
<div class="blockElement twoByGridBlock alignCenter">
<div class="blockContent">
<h3>Feature 1</h3>
<p>This is a description of the feature.</p>
</div>
</div>
<div class="blockElement twoByGridBlock alignCenter">
<div class="blockContent">
<h3>Feature 2</h3>
<p>This is another description of a feature.</p>
</div>
</div>
</div>
Use the first option as a preference, because it will make your site easier for non-technical folks to edit and update.
Gridblocks have additional options for layout compared to the above:
Left aligned:
{% include content/gridblocks.html data_source=site.data.features align="left" %}
Right aligned:
{% include content/gridblocks.html data_source=site.data.features align="right" %}
Images on the side:
{% include content/gridblocks.html data_source=site.data.features imagealign="side" %}
Four column layout:
{% include content/gridblocks.html data_source=site.data.features layout="fourColumn" align="center" %}