Add Mermaid support to the Corso documentation platform (#64)
* Add MDX and Mermaid * Configure Docusaurus for Mermaid
This commit is contained in:
parent
df23d2238a
commit
2564b32841
@ -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 \
|
||||
|
||||
@ -5,3 +5,8 @@ sidebar_position: 1
|
||||
# Repositories and configuration
|
||||
|
||||
How to configure Corso:
|
||||
|
||||
```mermaid
|
||||
graph TD;
|
||||
Corso-->S3;
|
||||
```
|
||||
|
||||
@ -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',
|
||||
},
|
||||
|
||||
5825
docs/package-lock.json
generated
5825
docs/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -18,6 +18,8 @@
|
||||
"@docusaurus/preset-classic": "2.0.0-beta.20",
|
||||
"@mdx-js/react": "^1.6.22",
|
||||
"clsx": "^1.1.1",
|
||||
"mdx-mermaid": "^1.2.2",
|
||||
"mermaid": "^8.11.5",
|
||||
"prism-react-renderer": "^1.3.1",
|
||||
"react": "^17.0.2",
|
||||
"react-dom": "^17.0.2"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user