Add Mermaid support to the Corso documentation platform (#64)

* Add MDX and Mermaid * Configure Docusaurus for Mermaid
alcionai · May 20, 2022 · 2564b32 · 2564b32
1 parent df23d22
commit 2564b32
Show file tree

Hide file tree

Showing 5 changed files with 14,861 additions and 9,042 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -12,7 +12,7 @@ check:
 	docker run --rm \
 		-v ${PWD}:/usr/src/docs alcion/docs vale docs README.md
 	docker run --rm \
-		-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/
+		-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore node_modules/
 
 shell:
 	docker run --rm -it \

diff --git a/docs/docs/concepts/corso-repository-and-configuration.md b/docs/docs/concepts/corso-repository-and-configuration.md
@@ -5,3 +5,8 @@ sidebar_position: 1
 # Repositories and configuration
 
 How to configure Corso:
+
+```mermaid
+graph TD;
+    Corso-->S3;
+```
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -32,11 +32,10 @@ const config = {
       'classic',
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
-          docs: {
-	      routeBasePath: '/',
+        docs: {
+          routeBasePath: '/',
           sidebarPath: require.resolve('./sidebars.js'),
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
+          remarkPlugins: [require('mdx-mermaid')],
           editUrl:
             'https://github.com/alcionai/corso/tree/main/docs',
         },