Acramsay/issue16 (#32)

* Fixing broken links * Add math fences with arithmatex * Update introductory statement * Update docs/index.md Co-authored-by: Adriel Perkins <[email protected]> --------- Co-authored-by: Adriel Perkins <[email protected]>
liatrio · Jan 17, 2024 · 32c2c16 · 32c2c16
1 parent 4724e80
commit 32c2c16
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 8 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -2,7 +2,7 @@
 
 ---
 
-*To improve, you must observe. Open O11y is one contribution from an internal Technical Advisory Group (TAG) focused on observability at [Liatrio](liatrio.com); geared towards this singular north star; enabling observability everywhere*
+*To improve, you must observe. Developed by an Observability Technical Advisory Group (TAG) at [Liatrio](https://www.liatrio.com/), Open O11y is a set of documentation, references, and guidance focused on observability.  Open O11y is guided by a singular north star, enabling observability everywhere.*
 
 ---
 
@@ -30,7 +30,7 @@ With that in mind, our goal is to help enable everyone in the industry observe t
 Here's some things you'll find through Open O11y that help achieve this goal:
 
 - Contributions to Open Source communities focused on O11y
-  - For example: [Open Telemetry](opentelemetry.io)
+  - For example: [Open Telemetry](https://opentelemetry.io/)
 - Open-source automations published to get organizations and teams started quickly
   - For example: An observability stack deployable in AWS
   - Guidance on how to use those automations & scale

diff --git a/docs/javascripts/config.js b/docs/javascripts/config.js
@@ -0,0 +1,12 @@
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -31,12 +31,25 @@ theme:
     - navigation.top
     - toc.follow
 
+extra_javascript:
+  - javascripts/config.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+
 markdown_extensions:
+  - pymdownx.arithmatex:
+      generic: true
   - pymdownx.superfences:
       custom_fences:
         - name: mermaid
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
+        - name: math
+          class: arithmatex
+          format:
+            !!python/object/apply:pymdownx.arithmatex.arithmatex_fenced_format {
+              which: generic,
+            }
   - footnotes
 
 extra_css:
@@ -56,9 +69,9 @@ nav:
           - "Leading Inidicators": "./guidance/metrics/leading-delivery-indicators.md"
           - "DevEx & Platform": "./guidance/metrics/devex-platform.md"
           - "Satisfaction & Well-Being": "./guidance/metrics/satisfaction-well-being.md"
-  - "O11y Quick Start Platform":
-      - "Overview": "./platform/README.md"
-      - "Architecture": "./platform/architecture.md"
-      - "Recommended Implementations":
-          - "AWS": "./platform/aws.md"
+  # - "O11y Quick Start Platform":
+  #     - "Overview": "./platform/README.md"
+  #     - "Architecture": "./platform/architecture.md"
+  #     - "Recommended Implementations":
+  #         - "AWS": "./platform/aws.md"
   - "Contributing": "./CONTRIBUTING.md"
diff --git a/pyproject.toml b/pyproject.toml
@@ -2,7 +2,10 @@
 name = "openo11y.dev"
 version = "0.1.0"
 description = "Openly Enabling O11y Everywhere"
-authors = ["Adriel Perkins <[email protected]>"]
+authors = [
+  "Adriel Perkins <[email protected]>",
+  "Alex Ramsay <[email protected]>",
+]
 license = "Apache-2.0"
 readme = "README.md"