How We Built This Site¶
This website was created using mostly open-source tools. We would like to acknowledge the work the developers did to contribute these tools to the community.
- GitHub - we use GitHub Pages to host this site and we use GitHub issues for tracking additions and change requests.
- Markdown - all the content in this site uses this format. Markdown is now the defacto format for GitHub documentation and for documenting code including the content within our Jupyter Notebooks.
- Conda Conda is Python Virtual Environment that allows us to keep our Python libraries in sync for each of our development projects. See our README.md file for specific site build instructions.
- mkdocs - a Python tool for converting Markdown into HTML. Mkdocs allows us to test the web site on our local systems before we commit our changes to the central GitHub repository.
- material theme - We love the material UI look and feel as well as all the additions they have provided.
- Admonitions - We use the Material Admonitions addon to display notes and warnings
- Visual Studio Code - Integrated Development Environment that has strong code completion for Markdown and mkdocs
- Grammarly
- [Grammarly VSCode Plugin] (https://marketplace.visualstudio.com/items?itemName=znck.grammarly)) - Grammer checking, spell checking etc.
- Google Analytics - we use the Mkdocs Material add on to add Google Analytics to all our pages. This allows us to track what pages people are viewing the most and how long they stay on our site.
- ChatGPT 4 - We use ChatGPT for brainstorming, list generation, diagram generation and other tasks.
- p5.js - We use Processing version five in JavaScript to generate diagrams and simulations