Additional notes to README.md 3635 cont

README.md

@@ -20,7 +20,7 @@ The initial installation of MkDocs included the following files:
 Site is live at [https://hackforla.github.io/website-wiki/](https://hackforla.github.io/website-wiki/)
 
 ## Deploying Documents
-[Documents are deployed](https://www.mkdocs.org/user-guide/deploying-your-docs/) in the appropriate subfolder under the `/docs/` folder. The documents are deployed whenever the `ci.yml` action is run.  
+[Documents are deployed](https://www.mkdocs.org/user-guide/deploying-your-docs/) in the appropriate subfolder under the `/docs/` folder. The documents are deployed whenever the `ci.yml` action is run.
 
 # Configuration Options  
 Following are descriptions of some of the many configuration options. 
@@ -35,13 +35,13 @@ The Material for MkDocs design theme includes multiple configuration and extensi
 
 
 
-### Material design customizations:  
+### Material design customizations
 
-- [Additional CSS](https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript) - recommended placement of new style sheet 
-- [Additional JS](https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript) - integrating other syntax or custom logic 
-- [Theme extension](https://squidfunk.github.io/mkdocs-material/customization/#extending-the-theme)
+- [Additional CSS](https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript) - using a separate style sheet to adjust specific elements  
+- [Additional JS](https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript) - integrating other syntax or adding custom logic to the theme
+- [Theme extension](https://squidfunk.github.io/mkdocs-material/customization/#extending-the-theme) - an easy way to override parts of Material for MkDocs without forking from git
 
-### Material design advanced configuration options:  
+### Material design advanced configuration options 
 
 - [Changing the colors](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#changing-the-colors)  
 - [Changing the fonts](https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#changing-the-fonts)  
@@ -62,19 +62,20 @@ The Material for MkDocs design theme includes multiple configuration and extensi
 - [Building an optimized site](https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#building-an-optimized-site)  
 - [Building for offline usage](https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#building-for-offline-usage)  
 
-### Python Markdown extension options include:   
+### Python Markdown extension options   
+There are two recommended Markdown extension packages, [Python Markdown](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/) and [Python Markdown Extensions](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/), that are supported by Material for MkDocs. The minimal and recommended configurations for extensions are:   
 
-  
-- [Minimal configuration]() when using Material for the first time
-- [Recommended configuration]() that enables all markdown-related features
-- Individual listings of markdown-related config options:
+- [Minimal configuration](https://squidfunk.github.io/mkdocs-material/setup/extensions/#minimal-configuration) when using Material for the first time
+- [Recommended configuration](https://squidfunk.github.io/mkdocs-material/setup/extensions/#recommended-configuration) that enables all Markdown-related features
+
+- Individual listings of Markdown-related config options from the two packages:
   - [Abbreviations](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#abbreviations) – ability to add a small tooltip to an element  
-  - [Admonition](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#admonition) – support for call-outs  
-  - [Arithmatex](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex) – allows rendering of math typesetting via MathJax  
+  - [Admonition](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#admonition) – support for call-outs (aka admonitions) 
+  - [Arithmatex](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex) – allows rendering of math typesetting via [MathJax](https://www.mathjax.org/)  
   - [Attribute Lists](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists) – allows adding HTML attributes and CSS classes  
-  - [BetterEm](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#betterem) – improves detection to emphasize text using spec. characters, i.e. bold, italic  
-  - [Caret, Mark & Tilde](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde) – add the ability to highlight text and define sub- and superscript  
-  - [Critic](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic) – allows usage of Critic Markup to highlight text/ track changes  
+  - [BetterEm](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#betterem) – improves detection to emphasize text using special characters, i.e. for bold and italic
+  - [Caret, Mark & Tilde](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde) – add the ability to highlight text and define sub- and superscripts  
+  - [Critic](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic) – allows usage of [Critic Markup](https://github.com/CriticMarkup/CriticMarkup-toolkit) to highlight text/ track changes  
   - [Definition Lists](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#definition-lists) – allows usage of definition/ description lists `dl` in HTML  
   - [Details](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details) – ‘supercharges the Admonition extension’ for collapsible call-outs  
   - [Emoji](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji) – inlines bundled and custom emojis and icons 
@@ -85,9 +86,8 @@ The Material for MkDocs design theme includes multiple configuration and extensi
   - [Markdown in HTML](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html) – allows wrapping markdown content with custom elements in HTML  
   - [SmartSymbols](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#smartsymbols) – converts characters into symbols, e.g. fractions, copyright mark, etc.  
   - [Snippets](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets) – add ability to embed content from arbitrary files into a document  
-  - [SuperFences](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences) – facilitates creation of flowcharts, sequence diagrams, etc.  
-  - [Tabbed]() – allows usage of content tabs  
+  - [SuperFences](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences) – facilitates creation of flowcharts, sequence diagrams, etc. including [Mermaid.js](https://mermaid-js.github.io/mermaid/) integration 
+  - [Tabbed](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tabbed) - allows usage of content tabs to group related content
   - [Table of Contents](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents) – automatically generates a table of contents
-  - [Tables](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#tables) – adds ability of create tables in markdown  
-  - [Tabbed](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tabbed) - allows usage of content tabs
-  - [Tasklist](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist) – allows usage of GitHub Flavored Markdown inspired tasklists  
+  - [Tables](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#tables) – adds ability of create tables in Markdown  
+  - [Tasklist](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist) – allows usage of [GitHub Flavored Markdown](https://github.github.com/gfm/) inspired tasklists