-
Notifications
You must be signed in to change notification settings - Fork 315
Tips
Vincent Rubinetti edited this page Apr 23, 2021
·
8 revisions
Tips/suggestions for creating a better site!
- If you're trying to link to an image in a GitHub repo, make sure to link to the actual raw image, not the GitHub page for the image file in the repo.
For example, use
https://raw.githubusercontent.com/greenelab/ponyo/master/logo.png
instead ofhttps://github.com/greenelab/ponyo/blob/master/logo.png
. - Use SVGs for images whenever possible, especially for your logo!
- Always provide a good thumbnail for your publications. Use a figure from the source, or if there are none, a journal logo or issue cover. Here are some best practices for making a good thumbnail image.
- Put a section break before every
# Heading 1
and## Heading 2
to visually break up your content and make it more readable. - On your contact page, put a mailing address for mail/deliveries, AND a navigation-friendly address so people can find their way to you easily.
- For your header/footer backgrounds, use an image that's not too busy or distracting so people can clearly read the content on top of it.
- A square version of your logo without text and with tight cropping (small or no margins) will look the best.
- Leave headers/footers the default dark background and use a light version of your logo. Having dark headers/footers makes them stand out from the default light background of the main page content.
✨ The documentation for v1.0.0
and above are now at https://greene-lab.gitbook.io/lab-website-template-docs.