visit the SCI Knowledge Base homepage

Documentation

Whenever committing to this repository, GitHub Pages will run Jekyll to rebuild the pages. Jekyll uses the Liquid templating language to process templates, providing a number of useful Liquid additions to build the site (e.g. filters and tags). See the official Liquid Documentation to learn more.

Jekyll Theme

The name of the theme is stored in the Jekyll _config.yml configuration file. You can either choose from one of the supported themes or use a remote-theme. To enable a theme:

theme: theme-name OR remote_theme: "author/theme-name"

The current theme is the remote theme vsoch/docsy-jekyll. Custom modifications to the remote theme include the sidebar and navigation functionality, additional layout templates and includes, custom styling as well as data storage and queries.

Markdown

Markdown makes it easy to style your writing, including conventions for

Syntax highlighted code block

Header 1

Header 2

Header 3

• Bulleted
• List

1. Numbered
2. List

Bold and Italic and Code text

Links

If you stumble upon a broken link, it is very likely you forgot to prepend the baseurl of the site (which is not automatically rendered). You can check the baseurl settings in the _config.yml configuration file. Fix:

{{ site.baseurl }}/your-link or {{ site.baseurl }}/{{ custom-page.url }} or {{ custom-page.url | prepend: site.baseurl }}

More fancy markdown: GitHub Flavored Markdown.

Kramdown

Not yet satisfied? Kramdown is the default Markdown renderer for Jekyll, offering you additional options for styling. Add for example {:.my-css-class} to tell Kramdown you want to apply your fancy custom CSS.

Inserting new content

References & Links

Create a new entry in data > references.yml or data > links.yml.

Pages, Terms & Concepts

Create a new markdown file (.md) in pages, terms > [first letter of entry] or concepts analogous to the existing entries to make sure all styles are applied.

Images

Upload the image into assets > img.

Linking shortcodes

Reference [[title]](({{ site.baseurl }}/resources/#references)

Link [[title]](({{ site.baseurl }}/resources/#links)

Page [title]({{ site.baseurl }}/[filename-goes-here])

Term [title]({{ site.baseurl }}/terms/[filename-goes-here])

Concept [title]({{ site.baseurl }}/concepts/[filename-goes-here])

Video on Vimeo <div class="media-wrapper"><iframe src="..." frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe></div><script src="https://player.vimeo.com/api/player.js"></script>

Video on YouTube <div class="media-wrapper"><iframe src="..." frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>

Image ![title](source){:.responsive-media}

Support

Github Pages documentation