Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize links and images in content #12

Open
rambaut opened this issue Aug 2, 2017 · 0 comments
Open

Standardize links and images in content #12

rambaut opened this issue Aug 2, 2017 · 0 comments

Comments

@rambaut
Copy link
Contributor

rambaut commented Aug 2, 2017

A few conventions to follow when creating content:

Internal Links:

These go in square brackets i.e., [beauti] will link to a page called BEAUti.html (case is ignored and the .html should be omitted for simplicity). To create a link with more readable text:
[BEAUti application](beauti).

Images:

Use the 'image.html' include like this:

{% include image.html file="image1.png" %}

This will link to images in the root level /images folder.

Use the prefix attribute to link elsewhere (still assumes an 'images' folder):

{% include image.html prefix="tutorials/tutorial1/" file="image1.png" %}

This will link to '/tutorials/tutorial1/images/image1.png'

The size of the image can be controlled with the 'width' setting:

{% include image.html width="50%" prefix="tutorials/tutorial1/" file="image1.png" %}

Specify width as a percentage of the page width so that it will scale on smaller devices like phones.

A caption can also be included:

{% include image.html caption="This is a nice image" width="50%" prefix="tutorials/tutorial1/" file="image1.png" %}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant