This repository contains the sources for the OGC Building Blocks documentation.
This repository uses Jekyll to build the documentation. Please follow GitHub's documentation on using Jekyll for more information.
For the truly impatient:
bundle install # Ruby dependencies (once)
python3 -m venv venv && . venv/bin/activate # Python dependencies (once)
pip install -r requirements.txt
python3 tools/build_search_index.py # search index (see below)
bundle exec jekyll serve
Access the page on:
http://127.0.0.1:4000/
The search box in the page header queries a pre-built index, generated by
tools/build_search_index.py (it needs the Python packages in requirements.txt, and a
bundle install'd Ruby environment, since it renders the pages with the same kramdown Jekyll uses).
It writes assets/search/search-index.<hash>.sqlite and _data/search_index.yml; both are gitignored build artifacts.
This step runs automatically on CI before the site is built, so you never need to commit the index. When serving locally, however, you need to run it yourself: without it the site still builds, but the search box will not work. Re-run it whenever you want search to reflect your changes to the pages.
The Minimal Mistakes Jekyll theme is used for styling.
_pages: contains the different pages that make up the documentation._data: additional files for layouts, configuration...navigation.yml: navigation sidebar
assets: contains images, css, js, etc.