Updating mkdocs versions and configuration (#107)

* edit note and mkdocs emoji * Moving to latest and greatest mkdocs insiders * updating actions * Correcting error * testing workflow * fixing actions file * latest and greatest on all the things * Moving build outside of PR stage * editing sample run * removing PR state * Correcting PR flow
aristanetworks · Oct 17, 2023 · fa5364c · fa5364c
1 parent 793842c
commit fa5364c
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 32 deletions.
diff --git a/.github/workflows/build-site.yml b/.github/workflows/build-site.yml
@@ -11,15 +11,15 @@ jobs:
     runs-on: ubuntu-latest
     name: Build and Deploy Job
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.x
 
       ##### Install required Python Modules and build the website #####
       - run: pip install -r requirements.txt
-      - run: pip install git+https://${{ secrets.MKDOCS_INSIDER_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git@8.5.11-insiders-4.27.0
+      - run: pip install git+https://${{ secrets.MKDOCS_INSIDER_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git
       - run: mkdocs gh-deploy --force
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -1,21 +1,15 @@
 name: Testing
 
 on:
-  # Run jobs on any Pull Request activity
-  pull_request_target:
-    types:
-      - opened
-      - edited
-      - synchronize
-      - ready_for_review
+  pull_request:
 
 jobs:
   pre_commit:
     name: Run pre-commit validation hooks
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
     - uses: pre-commit/action@v3.0.0
 
   # vale:
@@ -37,15 +31,14 @@ jobs:
     needs: pre_commit
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.x
 
       ##### Install required Python Modules and build the website #####
       - run: pip install -r requirements.txt
-      - run: pip install git+https://${{ secrets.MKDOCS_INSIDER_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git@8.5.11-insiders-4.27.0
       - run: mkdocs build --strict
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -49,8 +49,8 @@ markdown_extensions:
   - pymdownx.critic
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
       anchor_linenums: true
   - pymdownx.inlinehilite

diff --git a/requirements.txt b/requirements.txt
@@ -3,6 +3,7 @@ material
 md-toc
 mdx_truly_sane_lists
 mkdocs
+mkdocs-material
 mkdocs-git-revision-date-plugin
 mkdocs-glightbox
 mkdocs-include-dir-to-nav

diff --git a/workshops/cicd-basics.md b/workshops/cicd-basics.md
@@ -110,6 +110,9 @@ On the programmability IDE, merge the `cicd-ff` branch into the `main` branch.
 git merge origin/cicd-ff
 ```
 
+???+ note
+    You may get a note to edit the commit message, enter ***windows*** ++ctrl++ + X or ***mac*** ++cmd++ + X to save the message and exit out of the text editor.
+
 ### Setup lab password environment variable
 
 Each lab comes with a unique password. We set an environment variable called `LABPASSPHRASE` with the following command. The variable is later used to generate local user passwords and connect to our switches to push configs.

diff --git a/workshops/stylesheets/extra.material.css b/workshops/stylesheets/extra.material.css
@@ -14,7 +14,7 @@
 
     /* Accent color shades */
     --md-accent-fg-color:                #27569B;
-    --md-accent-bg-color:                #8c8c8f;
+    --md-accent-bg-color:                #27569B;
     --md-accent-bg-color--light:         #27569B;
 
     /* Link color */
@@ -61,16 +61,27 @@
   /* Custom Admonition eos-config */
 
   [data-md-color-scheme="slate"] {
+    /* Primary color shades */
+    --md-primary-fg-color:               #27569B;
+    --md-primary-fg-color--light:        #FFFFFF;
+    --md-primary-fg-color--dark:         #27569B;
+    --md-primary-bg-color:               #FFFFFF;
+    --md-primary-bg-color--light:        #FFFFFF;
+
+    /* Accent color shades */
+    --md-accent-fg-color:                #27569B;
+    --md-accent-bg-color:                #27569B;
+    --md-accent-bg-color--light:         #27569B;
 
     /* Link color */
-    --md-typeset-a-color:                #75aaf8;
+    --md-typeset-a-color:                #4473a9;
     --md-typeset-a-color-fg:             #FFFFFF;
     --md-typeset-a-color-bg:             #27569B;
 
     /* Code block color shades */
-    /* --md-code-bg-color:                  #E6E6E6; */
-    /*--md-code-border-color:              #aec6db4f;*/
-    /* --block-code-bg-color:               #e4e4e4; */
+    /* --md-code-bg-color:                  #E6E6E6;
+    --md-code-border-color:              #aec6db4f;
+    --block-code-bg-color:               #e4e4e4; */
   }
 
   [data-md-color-scheme="default"] {
@@ -87,7 +98,7 @@
     --md-accent-bg-color--light:         #27569B;
 
     /* Link color */
-    --md-typeset-a-color:                #27569B;
+    --md-typeset-a-color:                #4473a9;
     --md-typeset-a-color-fg:             #FFFFFF;
     --md-typeset-a-color-bg:             #27569B;
 
@@ -185,15 +196,16 @@
       border: 2px solid var(--md-code-border-color);
     }
     .md-typeset .admonition, .md-typeset details {
-        margin: 1.5625em 0;
-        padding: 0 .6rem;
-        overflow: hidden;
-        font-size: .64rem;
-        page-break-inside: avoid;
-        border-left: .2rem solid var(--md-accent-bg-color);
-        border-left-color: var(--md-accent-bg-color);
-        border-radius: .1rem;
-        box-shadow: 0 .2rem .5rem rgba(0,0,0,.05),0 0 .05rem rgba(0,0,0,.1);
+      margin: 1.5625em 0;
+      padding: 0 .6rem;
+      overflow: visible;
+      font-size: .64rem;
+      page-break-inside: avoid;
+      border-left: .2rem solid var(--md-accent-bg-color);
+      border-left-color: var(--md-accent-bg-color);
+      border-radius: .1rem;
+      border-width: thin;
+      box-shadow: 0 .2rem .5rem rgba(0,0,0,.05),0 0 .05rem rgba(0,0,0,.1);
     }
     /* .md-typeset .note > .admonition-title, .md-typeset .note > summary {
       background-color: var(--md-accent-bg-color);