Skip to content

Site References

  1. mkdocs - https://www.mkdocs.org/ - this is our tool for building the website. It converts Markdown into HTML in the site directory.
  2. mkdocs material theme - https://squidfunk.github.io/mkdocs-material/ - this is the theme for our site. The theme adds the user interface elements that give our site the look and feel. It also has the features such as social cards.
  3. GitHub Pages - https://pages.github.com/ - this is the free tool for hosting public websites created by mkdocs
  4. Markdown - https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown - this is the format we use for text. It allows us to have headers, lists, tables, links and images without learning HTML.
  5. Deploy Mkdocs GitHub Action - https://github.com/marketplace/actions/deploy-mkdocs - this is the tool we use to automatically build our site after edits are checked in with Git.
  6. Git Book - https://git-scm.com/book/en/v2 - a useful book on Git. Just read the first two chapters to learn how to check in new code.
  7. Conda - https://conda.io/ - this is a command line tool that keeps our Python libraries organized for each project.
  8. VS Code - https://code.visualstudio.com/ - this is the integrated development environment we use to mange the files on our website.
  9. Markdown Paste - https://marketplace.visualstudio.com/items?itemName=telesoho.vscode-markdown-paste-image - this is the VS code extension we use to make sure we keep the markdown format generated by ChatGPT.