Condon Research Group Docs

This is a repository for holding all things documentation that might be helpful. It has been created using mkdocs.

Contributing

To contribute first you need to be added to the repo. Reach out to Laura and/or Will to be added. Then clone this repo git clone git@github.com:condon-lab/Condon_Lab_Docs.git

Then you'll need to install the mkdocs package by running pip install mkdocs

Checkout a new branch where you can add/edit docs git checkout -b <branch-name>

Then edit docs to your heart's content! If you prefer to write documentation using google docs, you can convert a google doc to a markdown file easily using this chrome extension. Additionally, here are some helpful markdown tips and tricks.

If you want to add an image to your documentation simply add the image you want to the ./images directory and then reference the image using the relative path. e.g.

[alt text for your image](../../images/my_image.png)

If you remove an image from an existing doc, please remove the image file also.

You can then run mkdocs serve to see a local version of your new and updated docs in you browse at http://127.0.0.1:8000/

When everything looks good open a pull request to main and either ping in slack or assign Laura and/or Will to review.

After your PR has been appoved, merge it in and go check out your new docs over at https://condon-lab.github.io/Condon_Lab_Docs/