This site is built using jekyllrb.com
Any commits pushed to github or made directly on the site will be automatically published on github pages after a short delay.
Any member of the OCCC is welcome to contribute to the site. Email the current chair (see the index for contact info) or anyone listed on the contributors list of the repo for access.
Andrew Scholer did the initial site setup. Technical questions about it can be sent to him.
To add information about a completed meeting, upload any supporting files (images, pdfs, etc...)
to assets/files/YEAR/
. Then add a markdown document to _past_meetings
. See the README in _past_meetings
for instructions on content/formatting.
Many editors offer markdown preview if you want to examine what you are producing. You can also use the GitHub web interface to edit individual pages and preview the markdown before committing. However, Jekyll supports advanced features that the GitHub website does not. Fancier pages that render correctly on github pages may not render correctly if previewed on GitHub.
Because markdown file are converted to html and served in that format, internal
links should either use Jekyll links (preferred): {% link folder/file.md %}
or link html extension (file.md
should be linked as file.html
).
If you want do extensive editing, you may wish to install Jekyll to build pages in the exact same way that the GitHub pages system will. You can find instructions for doing so on the GitHub Test site locally with Jekyll docs page.
Any markdown file that does not begin with an underscore, and is not in a folder that begins with an underscore, will be turned into an html page. Here is a guide to GitHub's markdown syntax
If markdown is not sufficiently expressive, you can also embed html directly into a
markdown page. However, for ease of maintenance, avoid using html if markdown will
suffice for a purpose. To embed markdown inside of html, make sure to specify the attribute
markdown="1"
in the enclosing html element. (See docs)
Markdown files may have YAML formatted "front matter". In particular a title is encouraged for all pages - it will automatically be rendered at the top of the page as an <h1> tag.
---
title: Sample page
---
The file _config.yml contains high level options for the site. In particular, this is where the top navigation links are set from.
Documentation for customizing the theme (mimia) can be found here: https://www.rubydoc.info/gems/minima/2.5.1#Customization
The source code for Minima at GitHub: https://github.com/jekyll/minima
Note: The master branch of this project is often ahead of the version of minima currently available via ruby gems and in use on this site.