Linting, formatting, documentation comments

Author: garfieldnate

.editorconfig

@@ -14,3 +14,6 @@ trim_trailing_whitespace = false
 
 [*.yml]
 indent_size = 2
+
+[*.svg]
+indent_size = 2

.markdownlint.json

@@ -17,5 +17,8 @@
     },
     "MD026": {
         "punctuation": ".,;:。："
+    },
+    "MD025": {
+        "front_matter_title": ""
     }
 }

README.md

@@ -13,10 +13,12 @@ generator that uses Markdown files to generate a website. The theme is
 
 ## Setup/Running
 
-    python -m venv
-    source venv/bin/activate (or venv\Scripts\Activate on Windows)
-    pip install -r requirements.txt
-    mkdocs serve
+```shell
+python -m venv
+source venv/bin/activate (or venv\Scripts\Activate on Windows)
+pip install -r requirements.txt
+mkdocs serve # add -s to abort on any warnings
+```
 
 ## Deployment
 

docs/home/ResearchGroups.md

@@ -11,14 +11,15 @@ tags:
 There are many institutions conducting Soar research all over the world. In the
 following subsections, you can find links to some of them:
 
-- [University of Michigan Soar Group](http://soar.eecs.umich.edu/UofMSoarGroup)
+-   [University of Michigan Soar Group](http://soar.eecs.umich.edu/UofMSoarGroup)
   A full listing of all members of the University of Michigan Soar group and Alumnae
-- [Other Academic Institutions](./OtherAcademicInstitutions.md)
+-   [Other Academic Institutions](./OtherAcademicInstitutions.md)
   A listing of various research groups around the world who use Soar in their work.
-- [Commercial Soar Organizations](./CommercialSoarOrganizations.md)
+-   [Commercial Soar Organizations](./CommercialSoarOrganizations.md)
   A listing of companies that use Soar in commercial applications or consulting work.
-  Soar researchers keep in touch via the soar-group email mailing lists, which you can join on this page.
+  Soar researchers keep in touch via the soar-group email mailing lists, which
+  you can join on this page.
 
 If you would like to have a link to your research group or company listed on
-these pages, please send a brief summary and the URL to [email protected] with the
-subject "Soar Research Group".
+these pages, please send a brief summary and the URL to [John Laird]
+(mailto:[email protected]) with the subject "Soar Research Group".

main.py

@@ -1,3 +1,7 @@
+# This file is used by Mkdocs-Macros to define macros that can be used in the
+# markdown files. The macros are defined in the `define_env` function and can
+# be used in the markdown files by using the `{{macro_name}}` syntax.
+
 def define_env(env):
     "Defines macros for Mkdocs-Macros"