This repository contains a template for a sample research software project web site.
To view the web site, visit http://softwaresaved.github.io/sample-site.
The site is written in HTML and MarkDown, uses Jekyll templates and is rendered via GitHub pages.
This site is a template - it cannot be used as-is and requires customisation to your specific requirements.
If you wish to use it you should:
_config.yml
._includes
and
_layout
..md
file.Information on cloning, editing, and previewing the web site now follow.
The following sections describe how to edit and preview the web site.
sudo apt-get install -y git
git clone http://[email protected]/USERNAME/sample-site.git
cd sample-site
git fetch gh-pages
git origin fetch gh-pages
git fetch origin gh-pages
git checkout gh-pages
It is useful to set up Jekyll on your computer so you can preview your changes before commiting and pushing them.
Install Ruby 2.0+ and Ruby development kit:
sudo apt-get install -y ruby2.0 ruby2.0-dev
Install Ruby bundler Gem:
sudo gem2.0 install bundler
Install gems required by the web site, including the gh-pages gem:
gem install bundler
bundle exec jekyll serve
git commit -m "... ... ..."
git push origin gh-pages
<h1>
in HTML and #
in MarkDown) should be
avoided on pages.---
layout: page
title: TITLE
root: PATH_TO_ROOT_FOLDER
---
---
layout: page
title: Example Page
root: .
---
[Copyright and licence](./CopyrightLicence.html)
<h2>
in HTML and ##
in MarkDown) headings.[Some image]({{ site.baseurl }}/assets/somedirectory/someimage.jpg)
![Image description]({{ site.baseurl }}/assets/somedirectory/someimage.jpg)
Enclose multi-line excerpts in ~~~
~~~
delimiters.
<h2>
in HTML and ##
in MarkDown) and
level 3 (<h3>
in HTML and ###
in MarkDown) headings.{{ site.NAME }}
For support, contact {{ site.email }}.
# Purge the characters.
iconv -f utf-8 -t utf-8 -c before.md > after.md
# Compare the files to see what was replaced.
diff before.md after.md