How to use this wiki - glasgowlab/home GitHub Wiki

Who can access this wiki

This wiki is housed on Github and is not private, but I think only people who are members of our lab's GitHub organization can add or edit pages. It's not indexed by Google.

How to add/edit pages

  • Everyone is welcome to edit any of the pages using the "Edit" button at the upper right of any page, right above the sidebar.
  • You can also create new pages, and all pages automatically go into the "Pages" drop-down of the sidebar.
  • You can also add those pages into the structured sidebar below the "Pages" drop-down. That structured sidebar is itself just a file formatted in markdown, but unlike other pages it appears at all times in the wiki. Because it's just a markdown file, you can link to other pages using double brackets, i.e. [[page-you-want-to-link-to]]
  • More information on editing and adding pages to GitHub wikis is available from GitHub

How to write markdown

Markdown is meant to be easy and readable. Just type!

  • use # for section headers. # is a big title, while ## through ###### get progressively smaller
  • use - for bullet points. You can add spaces before them to indent.
  • use [text](link) to link somewhere, like another website.
  • use [[page-name]] to link to another page on the wiki, and [[page-name#section-name]] to link to a specific section.
  • use backticks `text` to get monospaced text with a gray background. Great for adding code. You can also make code/text blocks by using three backticks ``` text over many lines ```
  • Here's a more comprehensive resource for understanding markdown syntax: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
  • Alternatively, you can write pages in other formatting languages, by changing the "Edit Mode" option in the toolbar when editing a page. The other options are:
    • AsciiDoc
    • Creole
    • MediaWiki
    • Org-mode
    • Pod
    • RDoc
    • Textile
    • reStructuredText

How to search the wiki

  • Use the search bar at the very top of the GitHub page, the one that says "Search or jump to...".
  • After you type your search term, make sure you select "In this repository" and not "All GitHub"
  • When searching, GitHub automatically shows results from code in this repository first - this is not what you want. You should select "Wikis" from the left-hand sidebar to get results from wiki pages.
  • Advanced search terms are described here

How to add images to the wiki

To add an image, it needs to have a URL. Here is an example:

![](https://github.com/glasgowlab/home/blob/main/images/rosetta_logo.png)

If you would like to upload a new image, you can do so by storing it in this repository's images folder (https://github.com/glasgowlab/home/blob/main/images/)

Full instructions:

  • Navigate to < > Code in the toolbar
  • Click on the images folder
  • Click on Add file > Upload files
  • Drag your file into the box, then click on Commit changes once it is finished uploading
  • Return to the images folder, and click on the filename of your image, this will open it in the tab
  • Copy the URL
  • On the page where you want to insert the image, type ![](<URL>)
⚠️ **GitHub.com Fallback** ⚠️