lewisgross1296 / cnerg.github.com

CNERG Website

Tips on maintaining this website

This website uses Jekyll to automatically render a combination of HTML and Markdown pages.

The final rendering is based on a combination of the following:

• content in individual Markdown or HTML files
• data in structured data files that is processed onto pages
• layout templates
• CSS for style

For any given page, there should be a Markdown or HTML page in the repository that forms the basis of that page. At the top of the file, there will be metadata that helps understand how that page is rendered. Most important is the layout tag which indicates the layout file that is used to render that page.

In it's simplest form, the layout file will simply convert the markdown to HTML and render it as is. More complex layout files will process data into rendered HTML.

For example, the file that lists skills in the manual uses the desc_list template to process data from a file. The data file is specified using the data tag, and its data is processed into an HTML description list with an optional list of links. The layout file uses CSS tags to invoke different styles that are applied universally across the site, and included from a hierarchy of CSS files.

In order to edit this file, you can:

• edit the content in the file itself: community/manual/skills.md
• edit the desc_list layout file: _layouts/desc_list.html
• edit the data in the data file: _data/skilss.yml
• (advanced) edit the CSS style files: _sass/_variables.scss or _sass/_bootstrap_customization.scss

Local testing of file rendering

In order to test the rendering of the files, you can run a local Jekyll server using a docker image.

prompt%> cd <path-to-new-website-repo>

prompt%> docker run --rm --volume="$PWD:/srv/jekyll" --volume="$PWD/vendor/bundle:/usr/local/bundle" -p 4000:4000  jekyll/jekyll  jekyll serve

This will launch a local server that will constantly monitor the files and re-render them each time the files change. It may take some time to install jekyll's internal dependencies. (see here for more.)

You can then load the URL localhost:4000 in a browser on your native system.

Boostrap 4 Github Pages

A Bootstrap 4 start up project for Github Pages and Jekyll.

• A full Bootstrap 4 theme usable both on Github Pages and with a standalone Jekyll.
• Recompiles Bootstrap from SCSS files, which allows to customize Bootstrap's variables and use Bootstrap themes.
• Full support of Bootstrap's JavaScript plugins.
• Supports all features of Github Pages and Jekyll.

See the website for demonstration and documentation.

Contribution

See the contribution guide.

License

See the license file.

Notes

• Twitter timeline embedded successfully on GH pages thanks to: https://github.com/liquid-utilities/twitter-timeline