Fix View does not work via building from Dockerfile #713

chore(deps-dev): bump @sveltejs/kit from 1.0.0-next.301 to 1.0.0-next.303

.eslintrc.cjs

@@ -27,7 +27,8 @@ module.exports = {
 		ecmaVersion: 2019,
 		tsconfigRootDir: __dirname,
 		project: ['./tsconfig.json'],
-		extraFileExtensions: ['.svelte']
+		extraFileExtensions: ['.svelte'],
+		allowAutomaticSingleRunInference: true
 	},
 	env: {
 		browser: true,

.github/workflows/codeql-analysis.yml

@@ -35,7 +35,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

.github/workflows/cypress.yml

@@ -14,9 +14,9 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         id: yarn-and-build-cache
         with:
           path: |
@@ -27,17 +27,17 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node_modules-build-
 
-      - name: Lint
+      - name: Build & Lint
         run: |
           yarn install
-          yarn run lint
+          yarn build
+          yarn lint
 
       # Install NPM dependencies, cache them correctly
       # and run all Cypress tests
       - name: Cypress run
         uses: cypress-io/github-action@v2
         with:
-          build: yarn build
           start: yarn preview
           wait-on: 'http://localhost:3000'
           record: true

.github/workflows/deploy.yml

@@ -11,37 +11,23 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-node@v2
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
         with:
           node-version: '16'
-
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - uses: actions/cache@v2
-        id: yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
+          cache: yarn
 
       - name: Build & Deploy
         run: |
           npm i -g yarn
           export DEPLOY=true
-          [ "$GITHUB_EVENT_NAME" == "pull_request" ] && export BETA=true && rm -rf docs/beta/
           [ "$GITHUB_EVENT_NAME" != "pull_request" ] && rm -rf docs/_app/
           yarn install
-          yarn run lint
           version=$(yarn version --patch --no-git-tag-version | grep "New version" | cut -d':' -f 2)
           yarn build
-          cd bin
-          ./fix-path
+          yarn run lint
           cd ..
 
       - name: Deploy

.github/workflows/docker-publish.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Run tests
         run: |
@@ -38,7 +38,7 @@ jobs:
     if: github.event_name == 'push'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Build image
         run: docker build . --file Dockerfile --tag $IMAGE_NAME

.github/workflows/update-browserlist.yml

@@ -6,10 +6,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: npx browserslist@latest --update-db
       - name: Commit changes
-        uses: EndBug/add-and-commit@v7
+        uses: EndBug/add-and-commit@v9
         with:
           author_name: ${{ github.actor }}
           author_email: ${{ github.actor }}@users.noreply.github.com

.github/workflows/update-monaco-editor.yml

@@ -1,8 +1,7 @@
 name: Update Monaco-editor
 on:
   workflow_dispatch:
-  pull_request:
-    types: [opened]
+  push:
     branches:
       - 'dependabot/npm_and_yarn/develop/monaco-editor-**'
 
@@ -10,10 +9,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: ./bin/update-monaco
       - name: Commit changes
-        uses: EndBug/add-and-commit@v7
+        uses: EndBug/add-and-commit@v9
         with:
           author_name: ${{ github.actor }}
           author_email: ${{ github.actor }}@users.noreply.github.com

Dockerfile

@@ -6,11 +6,12 @@
 # Stop               : press ctrl + c 
 #                                     or 
 #                                        docker stop mermaid-live-editor
-FROM node:17.3.1 as mermaid-live-editor-builder 
+FROM node:17.8.0 as mermaid-live-editor-builder 
 COPY --chown=node:node . /home
 WORKDIR /home
 RUN yarn install
 RUN yarn build
 
 FROM nginx:alpine as mermaid-live-editor-runner
+COPY ./nginx.conf /etc/nginx/conf.d/default.conf
 COPY --from=mermaid-live-editor-builder --chown=nginx:nginx /home/docs /usr/share/nginx/html

cypress/integration/diagramUpdate.spec.ts

@@ -30,4 +30,14 @@ describe('Auto sync tests', () => {
 		cy.get('#view').should('not.have.class', 'outOfSync');
 		cy.getLocalStorage('codeStore').snapshot();
 	});
+
+	it('supports commenting code out/in', () => {
+		const cmd = Cypress.platform === 'darwin' ? 'meta' : 'ctrl';
+
+		cy.get('#editor').type(`{uparrow}{${cmd}}/`);
+		cy.get('#view').contains('Car').should('not.exist');
+
+		cy.get('#editor').type(`{uparrow}{${cmd}}/`);
+		cy.get('#view').contains('Car').should('exist');
+	});
 });

cypress/integration/docMap.spec.ts

@@ -0,0 +1,36 @@
+describe('Editor docs tests', () => {
+	beforeEach(() => {
+		cy.on('uncaught:exception', () => {
+			return false;
+		});
+		cy.clearLocalStorage();
+		cy.visit('/edit');
+		cy.contains('Sample Diagrams').click();
+	});
+
+	it('Test default loading', () => {
+		cy.get(`[data-cy=docs][href^="https://mermaid-js.github.io/mermaid"]`).should('exist');
+	});
+
+	it('Test to see if the correct URL loads when changing from one diagram to other', () => {
+		cy.contains('Flow Chart').click();
+		cy.get(`[data-cy=docs][href$="/#/flowchart"]`).should('exist');
+
+		cy.contains('Config').click();
+		cy.get(`[data-cy=docs][href$="/#/flowchart?id=configuration"]`).should('exist');
+
+		cy.contains('Sequence Diagram').click();
+		cy.get(`[data-cy=docs][href$="/#/sequenceDiagram?id=configuration"]`).should('exist');
+
+		cy.contains('Code').click();
+		cy.get(`[data-cy=docs][href$="/#/sequenceDiagram"]`).should('exist');
+	});
+
+	it("Test to check URLs for a case where config URL doesn't exist", () => {
+		cy.contains('State Diagram').click();
+		cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist');
+
+		cy.contains('Config').click();
+		cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist');
+	});
+});

cypress/integration/history.spec.ts

@@ -46,7 +46,9 @@ describe('Save History', () => {
 		cy.get('#historyList').contains('No items in History');
 	});
 
-	it('should auto save history', () => {
+	// TODO: Fix #639
+	// eslint-disable-next-line mocha/no-skipped-tests
+	xit('should auto save history', () => {
 		cy.get('#editor').type('  C --> HistoryTest');
 		cy.tick(70000);
 		cy.contains('Timeline').click();

cypress/integration/loadSite.spec.ts

@@ -17,7 +17,7 @@ describe('Site Loads', () => {
 		);
 		cy.url().should(
 			'include',
-			'/edit#eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ'
+			'/edit#pako:eNpVkM1qw0AMhF9F6NRC_AI-FBo7zSXQQHLz-iC8cnZJ9oe1TAm2373rmkKrk9B8MwyasAuascRbomjgWisPed6byiQ7iKOhhaJ4m48s4ILn5wz7l2OAwYQYrb-9bvx-haCaTivGIMb6-7JJ1Y__0_MMdXOiKCG2f5XrV5jh0NizyfH_FZM4uz6ansqeio4SVJRa3KHj5MjqXHtaDQrFsGOFZV419zQ-RKHyS0bHqEn4oK2EhDnmMfAOaZRwefoOS0kj_0K1pfwFtx2XbzAdW4g'
 		);
 		cy.contains('History').click();
 		cy.getLocalStorage('codeStore').snapshot();

cypress/snapshots.js

@@ -16,7 +16,7 @@ module.exports = {
       "1": "{\"code\":\"graph TD\\n    A[Party] -->|Get money| B(Go shopping!!)\\n    \",\"mermaid\":\"{\\n  \\\"theme\\\": \\\"forest\\\",\\n  \\\"test\\\": \\\"hello world\\\"\\n}\",\"updateEditor\":false,\"autoSync\":true,\"updateDiagram\":true,\"loader\":{\"type\":\"files\",\"config\":{\"codeURL\":\"https://gist.githubusercontent.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/raw/4eb03887e6a41397e80bdcdbf94017c498f8f1e2/code.mmd\",\"configURL\":\"https://gist.githubusercontent.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/raw/4eb03887e6a41397e80bdcdbf94017c498f8f1e2/config.json\"}}}"
     }
   },
-  "__version": "9.2.0",
+  "__version": "9.5.1",
   "Auto sync tests": {
     "should dim diagram when code is edited": {
       "1": "{\"code\":\"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)\\n    B --> C{Let me think}\\n    C -->|One| D[Laptop]\\n    C -->|Two| E[iPhone]\\n    C -->|Three| F[fa:fa-car Car]\\n    C --> Test\",\"mermaid\":\"{\\n  \\\"theme\\\": \\\"default\\\"\\n}\",\"updateEditor\":false,\"autoSync\":false,\"updateDiagram\":false}"

nginx.conf

@@ -0,0 +1,9 @@
+server { 
+ listen 80;
+ server_name mermaid;
+ location / {
+   root /usr/share/nginx/html;
+	 # Fallback to index.html for other paths
+   try_files $uri /index.html;
+ }
+}

package.json

@@ -5,8 +5,8 @@
 		"dev": "svelte-kit dev --host 0.0.0.0",
 		"build": "svelte-kit build",
 		"preview": "svelte-kit preview",
-		"lint": "prettier --check --plugin-search-dir=. . && eslint --ignore-path .gitignore .",
-		"lint:fix": "prettier --write --plugin-search-dir=. . && eslint --fix --ignore-path .gitignore .",
+		"lint": "prettier --check --plugin-search-dir=. .;eslint --ignore-path .gitignore .",
+		"lint:fix": "prettier --write --plugin-search-dir=. .;eslint --fix --ignore-path .gitignore .",
 		"format": "prettier --write --plugin-search-dir=. .",
 		"pre-commit": "lint-staged",
 		"postinstall": "husky install",
@@ -15,49 +15,50 @@
 	},
 	"devDependencies": {
 		"@cypress/snapshot": "^2.1.7",
-		"@sveltejs/adapter-static": "1.0.0-next.26",
-		"@sveltejs/kit": "1.0.0-next.232",
-		"@types/mermaid": "^8.2.7",
+		"@sveltejs/adapter-static": "1.0.0-next.29",
+		"@sveltejs/kit": "1.0.0-next.303",
+		"@types/mermaid": "^8.2.9",
 		"@types/pako": "^1.0.3",
 		"@typescript-eslint/eslint-plugin": "^4.33.0",
 		"@typescript-eslint/parser": "^4.33.0",
-		"autoprefixer": "^10.4.2",
-		"chai": "^4.3.4",
-		"cssnano": "^5.0.15",
-		"cypress": "9.3.1",
-		"cypress-localstorage-commands": "^1.6.1",
+		"autoprefixer": "^10.4.4",
+		"chai": "^4.3.6",
+		"cssnano": "^5.1.5",
+		"cypress": "9.5.2",
+		"cypress-localstorage-commands": "^1.7.0",
 		"eslint": "^7.32.0",
-		"eslint-config-prettier": "^8.1.0",
+		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-cypress": "^2.12.1",
 		"eslint-plugin-es": "^4.1.0",
 		"eslint-plugin-mocha": "^10.0.3",
 		"eslint-plugin-postcss-modules": "^2.0.0",
-		"eslint-plugin-svelte3": "^3.4.0",
-		"eslint-plugin-tailwindcss": "^3.3.0",
+		"eslint-plugin-svelte3": "^3.4.1",
+		"eslint-plugin-tailwindcss": "^3.5.0",
 		"husky": "^7.0.4",
-		"lint-staged": "^12.2.1",
-		"mocha": "^9.1.4",
-		"node-html-parser": "^5.2.0",
-		"postcss": "^8.4.5",
-		"postcss-load-config": "^3.1.1",
-		"prettier": "~2.5.1",
+		"lint-staged": "^12.3.7",
+		"mocha": "^9.2.2",
+		"node-html-parser": "^5.3.3",
+		"postcss": "^8.4.12",
+		"postcss-load-config": "^3.1.3",
+		"prettier": "~2.6.1",
 		"prettier-plugin-svelte": "^2.6.0",
-		"svelte": "^3.46.2",
-		"svelte-preprocess": "^4.10.2",
-		"tailwindcss": "^3.0.13",
+		"svelte": "^3.46.4",
+		"svelte-preprocess": "^4.10.4",
+		"tailwindcss": "^3.0.21",
 		"tslib": "^2.3.1",
-		"typescript": "^4.5.4"
+		"typescript": "^4.6.3"
 	},
 	"type": "module",
 	"dependencies": {
 		"@analytics/google-analytics": "^0.5.3",
-		"@macfja/svelte-persistent-store": "^1.2.0",
-		"analytics": "^0.7.21",
-		"daisyui": "1.24.3",
+		"@macfja/svelte-persistent-store": "^1.3.0",
+		"analytics": "^0.8.1",
+		"daisyui": "2.13.0",
 		"js-base64": "^3.7.2",
-		"mermaid": "8.13.9",
+		"mermaid": "8.14.0",
 		"moment": "^2.29.1",
-		"monaco-editor": "^0.31.1",
+		"monaco-editor": "^0.33.0",
+		"monaco-mermaid": "^1.0.3",
 		"pako": "2.0.4",
 		"random-word-slugs": "^0.1.6"
 	},

src/app.html

@@ -11,31 +11,31 @@
 		<meta
 			name="description"
 			content="Simplify documentation and avoid heavy tools. Open source Visio Alternative. Commonly used for explaining your code! Mermaid is a simple markdown-like script language for generating charts from text via javascript." />
-		<link rel="icon" type="image/png" href="favicon.png" />
-		<link rel="manifest" href="manifest.json" />
+		<link rel="icon" type="image/png" href="%svelte.assets%/favicon.png" />
+		<link rel="manifest" href="%svelte.assets%/manifest.json" />
 		<link
 			rel="stylesheet"
 			href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.2/css/all.min.css" />
 		<link
 			rel="stylesheet"
-			href="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs/editor/editor.main.min.css"
+			href="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.min.css"
 			crossorigin="anonymous"
 			referrerpolicy="no-referrer" />
 		<script>
 			var require = {
-				paths: { vs: 'https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs' }
+				paths: { vs: 'https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs' }
 			};
 		</script>
 		<script
-			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs/loader.min.js"
+			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/loader.min.js"
 			crossorigin="anonymous"
 			referrerpolicy="no-referrer"></script>
 		<script
-			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs/editor/editor.main.nls.min.js"
+			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.nls.min.js"
 			crossorigin="anonymous"
 			referrerpolicy="no-referrer"></script>
 		<script
-			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.31.1/min/vs/editor/editor.main.js"
+			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.js"
 			crossorigin="anonymous"
 			referrerpolicy="no-referrer"></script>
 

src/hooks.ts

@@ -1,7 +1,7 @@
 import type { Handle } from '@sveltejs/kit/types/hooks';
 
-export const handle: Handle = async ({ request, resolve }) => {
-	const response = await resolve(request, {
+export const handle: Handle = async ({ event, resolve }) => {
+	const response = await resolve(event, {
 		ssr: false
 	});
 

src/lib/components/card/tabs.svelte

@@ -26,7 +26,7 @@
 		<ul class="tabs" transition:fade>
 			{#each tabs as tab}
 				<div
-					class="tab tab-lifted text-primary-content {activeTabID === tab.id ? 'tab-active' : ''}"
+					class="tab tab-lifted {activeTabID === tab.id ? 'tab-active' : 'text-primary-content'}"
 					on:click|stopPropagation={() => toggleTabs(tab)}>
 					<i class="mr-1 {tab.icon}" />
 					{tab.title}

src/lib/components/editor.svelte

@@ -4,7 +4,7 @@
 	import { themeStore } from '$lib/util/theme';
 	import type monaco from 'monaco-editor';
 	import { createEventDispatcher, onMount } from 'svelte';
-	import { initEditor } from './util';
+	import initEditor from 'monaco-mermaid';
 
 	let divEl: HTMLDivElement = null;
 	let editor: monaco.editor.IStandaloneCodeEditor;

src/lib/components/editor/util.ts

@@ -1,552 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-export const initEditor = (monacoEditor): void => {
-	monacoEditor.languages.register({ id: 'mermaid' });
-
-	const requirementDiagrams = [
-		'requirement',
-		'functionalRequirement',
-		'interfaceRequirement',
-		'performanceRequirement',
-		'physicalRequirement',
-		'designConstraint'
-	];
-
-	const keywords: {
-		[key: string]: {
-			typeKeywords: string[];
-			blockKeywords: string[];
-			keywords: string[];
-		};
-	} = {
-		flowchart: {
-			typeKeywords: ['flowchart', 'flowchart-v2', 'graph'],
-			blockKeywords: ['subgraph', 'end'],
-			keywords: [
-				'TB',
-				'TD',
-				'BT',
-				'RL',
-				'LR',
-				'click',
-				'call',
-				'href',
-				'_self',
-				'_blank',
-				'_parent',
-				'_top',
-				'linkStyle',
-				'style',
-				'classDef',
-				'class',
-				'direction',
-				'interpolate'
-			]
-		},
-		sequenceDiagram: {
-			typeKeywords: ['sequenceDiagram'],
-			blockKeywords: ['alt', 'par', 'and', 'loop', 'else', 'end', 'rect', 'opt', 'alt', 'rect'],
-			keywords: [
-				'participant',
-				'as',
-				'Note',
-				'note',
-				'right of',
-				'left of',
-				'over',
-				'activate',
-				'deactivate',
-				'autonumber',
-				'title',
-				'actor'
-			]
-		},
-		classDiagram: {
-			typeKeywords: ['classDiagram', 'classDiagram-v2'],
-			blockKeywords: ['class'],
-			keywords: [
-				'link',
-				'click',
-				'callback',
-				'call',
-				'href',
-				'cssClass',
-				'direction',
-				'TB',
-				'BT',
-				'RL',
-				'LR'
-			]
-		},
-		stateDiagram: {
-			typeKeywords: ['stateDiagram', 'stateDiagram-v2'],
-			blockKeywords: ['state', 'note', 'end'],
-			keywords: ['state', 'as', 'hide empty description', 'direction', 'TB', 'BT', 'RL', 'LR']
-		},
-		erDiagram: {
-			typeKeywords: ['erDiagram'],
-			blockKeywords: [],
-			keywords: []
-		},
-		journey: {
-			typeKeywords: ['journey'],
-			blockKeywords: ['section'],
-			keywords: ['title']
-		},
-		info: {
-			typeKeywords: ['info'],
-			blockKeywords: [],
-			keywords: ['showInfo']
-		},
-		gantt: {
-			typeKeywords: ['gantt'],
-			blockKeywords: [],
-			keywords: [
-				'title',
-				'dateFormat',
-				'axisFormat',
-				'todayMarker',
-				'section',
-				'excludes',
-				'inclusiveEndDates'
-			]
-		},
-		requirementDiagram: {
-			typeKeywords: ['requirement', 'requirementDiagram'],
-			blockKeywords: requirementDiagrams.concat('element'),
-			keywords: []
-		},
-		gitGraph: {
-			typeKeywords: ['gitGraph'],
-			blockKeywords: [],
-			keywords: ['commit', 'branch', 'merge', 'reset', 'checkout', 'LR', 'BT']
-		},
-		pie: {
-			typeKeywords: ['pie'],
-			blockKeywords: [],
-			keywords: ['title', 'showData']
-		}
-	};
-
-	// Register a tokens provider for the mermaid language
-	monacoEditor.languages.setMonarchTokensProvider('mermaid', {
-		...Object.entries(keywords)
-			.map((entry) =>
-				Object.fromEntries(
-					Object.entries(entry[1]).map((deepEntry) => [
-						entry[0] + deepEntry[0][0].toUpperCase() + deepEntry[0].slice(1),
-						deepEntry[1]
-					])
-				)
-			)
-			.reduce((overallKeywords, nextKeyword) => ({ ...overallKeywords, ...nextKeyword }), {}),
-		tokenizer: {
-			root: [
-				[/%%(?=.*%%$)/, { token: 'string', nextEmbedded: 'json' }],
-				[/%%$/, { token: 'string', nextEmbedded: '@pop' }],
-				[/^\s*gitGraph/m, 'typeKeyword', 'gitGraph'],
-				[/^\s*info/m, 'typeKeyword', 'info'],
-				[/^\s*pie/m, 'typeKeyword', 'pie'],
-				[/^\s*(flowchart|flowchart-v2|graph)/m, 'typeKeyword', 'flowchart'],
-				[/^\s*sequenceDiagram/, 'typeKeyword', 'sequenceDiagram'],
-				[/^\s*classDiagram(-v2)?/, 'typeKeyword', 'classDiagram'],
-				[/^\s*journey/, 'typeKeyword', 'journey'],
-				[/^\s*gantt/, 'typeKeyword', 'gantt'],
-				[/^\s*stateDiagram(-v2)?/, 'typeKeyword', 'stateDiagram'],
-				[/^\s*erDiagram/, 'typeKeyword', 'erDiagram'],
-				[/^\s*requirement(Diagram)?/, 'typeKeyword', 'requirementDiagram'],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment']
-			],
-			gitGraph: [
-				[/option(?=s)/, { token: 'typeKeyword', next: 'optionsGitGraph' }],
-				[/(^\s*branch|reset|merge|checkout)(.*$)/, ['keyword', 'variable']],
-				[
-					/[a-zA-Z][\w$]*/,
-					{
-						cases: {
-							'@gitGraphBlockKeywords': 'typeKeyword',
-							'@gitGraphKeywords': 'keyword'
-						}
-					}
-				],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment'],
-				[/".*?"/, 'string'],
-				[/\^/, 'delimiter.bracket']
-			],
-			optionsGitGraph: [
-				[/s$/, { token: 'typeKeyword', nextEmbedded: 'json', matchOnlyAtLineStart: false }],
-				['end', { token: 'typeKeyword', next: '@pop', nextEmbedded: '@pop' }]
-			],
-			info: [
-				[
-					/[a-zA-Z][\w$]*/,
-					{
-						cases: {
-							'@infoBlockKeywords': 'typeKeyword',
-							'@infoKeywords': 'keyword'
-						}
-					}
-				]
-			],
-			pie: [
-				[/(title)(.*$)/, ['keyword', 'string']],
-				[
-					/[a-zA-Z][\w$]*/,
-					{
-						cases: {
-							'@pieBlockKeywords': 'typeKeyword',
-							'@pieKeywords': 'keyword'
-						}
-					}
-				],
-				[/".*?"/, 'string'],
-				[/\s*\d+/, 'number'],
-				[/:/, 'delimiter.bracket'],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment']
-			],
-			flowchart: [
-				[/[ox]?(--+|==+)[ox]/, 'transition'],
-				[
-					/[a-zA-Z][\w$]*/,
-					{
-						cases: {
-							'@flowchartBlockKeywords': 'typeKeyword',
-							'@flowchartKeywords': 'keyword',
-							'@default': 'variable'
-						}
-					}
-				],
-				[/\|+.+?\|+/, 'string'],
-				[/\[+(\\.+?[\\/]|\/.+?[/\\])\]+/, 'string'],
-				[/[[>]+[^\]|[]+?\]+/, 'string'],
-				[/{+.+?}+/, 'string'],
-				[/\(+.+?\)+/, 'string'],
-				[/-\.+->?/, 'transition'],
-				[/(-[-.])([^->]+?)(-{3,}|-{2,}>|\.-+>)/, ['transition', 'string', 'transition']],
-				[/(==+)([^=]+?)(={3,}|={2,}>)/, ['transition', 'string', 'transition']],
-				[/<?(--+|==+)>|===+|---+/, 'transition'],
-				[/:::/, 'transition'],
-				[/[;&]/, 'delimiter.bracket'],
-				[/".*?"/, 'string'],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment']
-			],
-			sequenceDiagram: [
-				[
-					/[a-zA-Z][\w$]*/,
-					{
-						cases: {
-							'@sequenceDiagramBlockKeywords': 'typeKeyword',
-							'@sequenceDiagramKeywords': 'keyword',
-							'@default': 'variable'
-						}
-					}
-				],
-				[/(--?>?>|--?[)x])[+-]?/, 'transition'],
-				[/(:)([^:\n]*?$)/, ['delimiter.bracket', 'string']],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment']
-			],
-			classDiagram: [
-				[/(?!class\s)([a-zA-Z]+)(\s+[a-zA-Z]+)/, ['type', 'variable']],
-				[/(\*|<\|?|o)?(--|\.\.)(\*|\|?>|o)?/, 'transition'],
-				[/^\s*class\s(?!.*\{)/, 'keyword'],
-				[
-					/[a-zA-Z][\w$]*/,
-					{
-						cases: {
-							'@classDiagramBlockKeywords': 'typeKeyword',
-							'@classDiagramKeywords': 'keyword',
-							'@default': 'variable'
-						}
-					}
-				],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment'],
-				[/(<<)(.+?)(>>)/, ['delimiter.bracket', 'annotation', 'delimiter.bracket']],
-				[/".*?"/, 'string'],
-				[/:::/, 'transition'],
-				[/:|\+|-|#|~|\*\s*$|\$\s*$|\(|\)|{|}/, 'delimiter.bracket']
-			],
-			journey: [
-				[/(title)(.*)/, ['keyword', 'string']],
-				[/(section)(.*)/, ['typeKeyword', 'string']],
-				[
-					/[a-zA-Z][\w$]*/,
-					{
-						cases: {
-							'@journeyBlockKeywords': 'typeKeyword',
-							'@journeyKeywords': 'keyword',
-							'@default': 'variable'
-						}
-					}
-				],
-				[
-					/(^\s*.+?)(:)(.*?)(:)(.*?)([,$])/,
-					[
-						'string',
-						'delimiter.bracket',
-						'number',
-						'delimiter.bracket',
-						'variable',
-						'delimiter.bracket'
-					]
-				],
-				[/,/, 'delimiter.bracket'],
-				[/(^\s*.+?)(:)([^:]*?)$/, ['string', 'delimiter.bracket', 'variable']],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment']
-			],
-			gantt: [
-				[/(title)(.*)/, ['keyword', 'string']],
-				[/(section)(.*)/, ['typeKeyword', 'string']],
-				[
-					/[a-zA-Z][\w$]*/,
-					{
-						cases: {
-							'@ganttBlockKeywords': 'typeKeyword',
-							'@ganttKeywords': 'keyword'
-						}
-					}
-				],
-				[/(^\s*.*?)(:)/, ['string', 'delimiter.bracket']],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment'],
-				[/:/, 'delimiter.bracket']
-			],
-			stateDiagram: [
-				[/note[^:]*$/, { token: 'typeKeyword', next: 'stateDiagramNote' }],
-				['hide empty description', 'keyword'],
-				[/^\s*state\s(?!.*\{)/, 'keyword'],
-				[/(<<)(fork|join|choice)(>>)/, 'annotation'],
-				[/(\[\[)(fork|join|choice)(]])/, ['delimiter.bracket', 'annotation', 'delimiter.bracket']],
-				[
-					/[a-zA-Z][\w$]*/,
-					{
-						cases: {
-							'@stateDiagramBlockKeywords': 'typeKeyword',
-							'@stateDiagramKeywords': 'keyword',
-							'@default': 'variable'
-						}
-					}
-				],
-				[/".*?"/, 'string'],
-				[/(:)([^:\n]*?$)/, ['delimiter.bracket', 'string']],
-				[/{|}/, 'delimiter.bracket'],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment'],
-				[/-->/, 'transition'],
-				[/\[.*?]/, 'string']
-			],
-			stateDiagramNote: [
-				[/^\s*end note$/, { token: 'typeKeyword', next: '@pop' }],
-				[/.*/, 'string']
-			],
-			erDiagram: [
-				[/[}|][o|](--|\.\.)[o|][{|]/, 'transition'],
-				[/".*?"/, 'string'],
-				[/(:)(.*?$)/, ['delimiter.bracket', 'string']],
-				[/:|{|}/, 'delimiter.bracket'],
-				[/([a-zA-Z]+)(\s+[a-zA-Z]+)/, ['type', 'variable']],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment'],
-				[/[a-zA-Z_-][\w$]*/, 'variable']
-			],
-			requirementDiagram: [
-				[/->|<-|-/, 'transition'],
-				[/(\d+\.)*\d+/, 'number'],
-				[
-					/[a-zA-Z_-][\w$]*/,
-					{
-						cases: {
-							'@requirementDiagramBlockKeywords': 'typeKeyword',
-							'@default': 'variable'
-						}
-					}
-				],
-				[/:|{|}|\//, 'delimiter.bracket'],
-				[/%%[^$]([^%]*(?!%%$)%?)*$/, 'comment'],
-				[/".*?"/, 'string']
-			]
-		}
-	});
-
-	monacoEditor.editor.defineTheme('mermaid-dark', {
-		base: 'vs-dark',
-		inherit: true,
-		rules: [
-			{ token: 'typeKeyword', foreground: '9650c8', fontStyle: 'bold' },
-			{ token: 'transition', foreground: '008800', fontStyle: 'bold' }
-		],
-		colors: {}
-	});
-
-	monacoEditor.editor.defineTheme('mermaid', {
-		base: 'vs',
-		inherit: true,
-		rules: [
-			{ token: 'typeKeyword', foreground: '9650c8', fontStyle: 'bold' },
-			{ token: 'keyword', foreground: '649696' },
-			{ token: 'custom-error', foreground: 'ff0000', fontStyle: 'bold' },
-			{ token: 'string', foreground: 'AA8500' },
-			{ token: 'transition', foreground: '008800', fontStyle: 'bold' },
-			{ token: 'delimiter.bracket', foreground: '000000', fontStyle: 'bold' },
-			{ token: 'annotation', foreground: '4b4b96' },
-			{ token: 'number', foreground: '4b4b96' },
-			{ token: 'comment', foreground: '888c89' },
-			{ token: 'variable', foreground: 'A22889' },
-			{ token: 'type', foreground: '2BDEA8' }
-		],
-		colors: {}
-	});
-
-	// Register a completion item provider for the mermaid language
-	monacoEditor.languages.registerCompletionItemProvider('mermaid', {
-		provideCompletionItems: () => {
-			const suggestions = [
-				{
-					label: 'loop',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['loop ${1:Loop text}', '\t$0', 'end'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'Sequence Diagram Loops'
-				},
-				{
-					label: 'alt',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['alt ${1:Describing text}', '\t$0', 'else', '\t', 'end'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'Alternative Path'
-				},
-				{
-					label: 'opt',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['opt ${1:Describing text}', '\t$0', 'end'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'Optional Path'
-				},
-				{
-					label: 'par',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: [
-						'par ${1:[Action 1]}',
-						'\t$0',
-						'and ${2:[Action 2]}',
-						'\t',
-						'and ${3:[Action 3]}',
-						'\t',
-						'end'
-					].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'Parallel Actions'
-				},
-				{
-					label: 'rect',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['rect ${1:rgb(0, 255, 0)}', '\t$0', 'end'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'Background Color'
-				},
-				{
-					label: 'subgraph',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['subgraph ${1:title}', '\t$0', 'end'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'Subgraph'
-				},
-				{
-					label: 'class',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['class ${1:className} {', '\t$0', '}'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'Class'
-				},
-				{
-					label: 'state',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['state ${1:stateName} {', '\t$0', '}'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'State'
-				},
-				{
-					label: 'note',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['note ${1:right of State1}', '\t$0', 'end note'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'State'
-				},
-				{
-					label: 'section',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['section ${1:Go to work}', '\t$0'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'User-journey Section'
-				},
-				{
-					label: 'element',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['element ${1:test_entity} {', '\t$0', '}'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'Requirement Diagram Element'
-				},
-				{
-					label: 'options',
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: ['options', '{', '    $0', '}', 'end'].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: 'Git Graph Options'
-				},
-				...requirementDiagrams.map((requirementDiagramType) => ({
-					label: requirementDiagramType,
-					kind: monacoEditor.languages.CompletionItemKind.Snippet,
-					insertText: [
-						requirementDiagramType + ' ${1:test_req} {',
-						'\tid: 1',
-						'\ttext: the test text.',
-						'\trisk: high',
-						'\tverifyMethod: test',
-						'}'
-					].join('\n'),
-					insertTextRules: monacoEditor.languages.CompletionItemInsertTextRule.InsertAsSnippet,
-					documentation: requirementDiagramType
-						.split(/(?=[A-Z])/)
-						.map((part) => part[0].toUpperCase() + part.slice(1))
-						.join(' ')
-				})),
-				...[
-					...new Set(
-						Object.values(keywords)
-							.map((diagramKeywords) =>
-								Object.entries(diagramKeywords)
-									.filter((keywordType) => keywordType[0] !== 'annotations')
-									.map((entry) => entry[1])
-							)
-							.flat(2)
-					)
-				].map((keyword) => ({
-					label: keyword,
-					kind: monacoEditor.languages.CompletionItemKind.Keyword,
-					insertText: keyword
-				}))
-			];
-			return { suggestions: suggestions };
-		}
-	});
-
-	monacoEditor.languages.setLanguageConfiguration('mermaid', {
-		autoClosingPairs: [
-			{
-				open: '(',
-				close: ')'
-			},
-			{
-				open: '{',
-				close: '}'
-			},
-			{
-				open: '[',
-				close: ']'
-			}
-		],
-		brackets: [
-			['(', ')'],
-			['{', '}'],
-			['[', ']']
-		]
-	});
-};

src/lib/types.d.ts

@@ -57,4 +57,11 @@ export interface HistoryEntry {
 	url?: string;
 }
 
+export interface DocConfig {
+	[key: string]: {
+		code: string;
+		config?: string;
+	};
+}
+
 type Loader = (url: string) => Promise<State>;

src/routes/edit.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-	import Editor from '$lib/components/editor/editor.svelte';
+	import Editor from '$lib/components/editor.svelte';
 	import Navbar from '$lib/components/navbar.svelte';
 	import Preset from '$lib/components/preset.svelte';
 	import Actions from '$lib/components/actions.svelte';
@@ -12,17 +12,58 @@
 	import { onMount } from 'svelte';
 	import mermaid from 'mermaid';
 	import type monaco from 'monaco-editor';
-	import type { EditorUpdateEvent, State, Tab } from '$lib/types';
+	import type { EditorUpdateEvent, State, Tab, DocConfig } from '$lib/types';
 	import { base } from '$app/paths';
 
 	serializedState; // Weird fix for error > serializedState is not defined. Treeshaking?
-	let selectedMode = 'code';
-	const languageMap = {
+
+	type Modes = 'code' | 'config';
+	type Languages = 'mermaid' | 'json';
+
+	let selectedMode: Modes = 'code';
+	const languageMap: { [key in Modes]: Languages } = {
 		code: 'mermaid',
 		config: 'json'
 	};
+	const docURLBase = 'https://mermaid-js.github.io/mermaid';
+	const docMap: DocConfig = {
+		graph: {
+			code: '/#/flowchart',
+			config: '/#/flowchart?id=configuration'
+		},
+		flowchart: {
+			code: '/#/flowchart',
+			config: '/#/flowchart?id=configuration'
+		},
+		sequenceDiagram: {
+			code: '/#/sequenceDiagram',
+			config: '/#/sequenceDiagram?id=configuration'
+		},
+		classDiagram: {
+			code: '/#/classDiagram',
+			config: '/#/classDiagram?id=configuration'
+		},
+		'stateDiagram-v2': {
+			code: '/#/stateDiagram'
+		},
+		gantt: {
+			code: '/#/gantt',
+			config: '/#/gantt?id=configuration'
+		},
+		pie: {
+			code: '/#/pie'
+		},
+		erDiagram: {
+			code: '/#/entityRelationshipDiagram',
+			config: '/#/entityRelationshipDiagram?id=styling'
+		},
+		journey: {
+			code: '/#/user-journey'
+		}
+	};
 	let text = '';
-	let language: 'mermaid' | 'json' = 'mermaid';
+	let docURL = docURLBase;
+	let language: Languages = 'mermaid';
 	let errorMarkers: monaco.editor.IMarkerData[] = [];
 	$: language = languageMap[selectedMode];
 	$: {
@@ -37,10 +78,16 @@
 		if (state.updateEditor) {
 			text = selectedMode === 'code' ? state.code : state.mermaid;
 		}
+		const codeTypeMatch = /([\S]+)[\s\n]/.exec(state.code);
+		if (codeTypeMatch && codeTypeMatch.length > 1) {
+			const docKey = codeTypeMatch[1];
+			const docConfig = docMap[docKey] ?? { code: '' };
+			docURL = docURLBase + (docConfig[selectedMode] ?? docConfig.code ?? '');
+		}
 	});
 	const tabSelectHandler = (message: CustomEvent<Tab>) => {
+		selectedMode = message.detail.id === 'code' ? 'code' : 'config';
 		$codeStore.updateEditor = true;
-		selectedMode = message.detail.id;
 	};
 	const tabs: Tab[] = [
 		{
@@ -128,24 +175,28 @@
 			<Card on:select={tabSelectHandler} {tabs} isCloseable={false} title="Mermaid">
 				<div slot="actions">
 					<div class="flex flex-row items-center">
+						<div class="form-control flex-row items-center">
+							<label class="cursor-pointer label" for="autoSync">
+								<span> Auto sync</span>
+								<input
+									type="checkbox"
+									class="toggle {$codeStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1"
+									id="autoSync"
+									bind:checked={$codeStore.autoSync} />
+							</label>
+						</div>
+
 						{#if !$codeStore.autoSync}
 							<button
-								class="btn btn-secondary btn-xs"
+								class="btn btn-secondary btn-xs mr-1"
 								title="Sync Diagram"
 								data-cy="sync"
 								on:click={syncDiagram}><i class="fas fa-sync" /></button>
 						{/if}
 
-						<div class="form-control">
-							<label class="cursor-pointer label" for="autoSync">
-								<input
-									type="checkbox"
-									class="toggle toggle-primary mr-1"
-									id="autoSync"
-									bind:checked={$codeStore.autoSync} />
-								<span> Auto sync</span>
-							</label>
-						</div>
+						<button class="btn btn-secondary btn-xs" title="View documentation">
+							<a target="_blank" href={docURL} data-cy="docs"><i class="fas fa-book mr-1" />Docs</a>
+						</button>
 					</div>
 				</div>
 
@@ -163,9 +214,9 @@
 			<Card title="Diagram" isCloseable={false}>
 				<button
 					slot="actions"
-					class="btn btn-primary btn-xs shadow-lg"
+					class="btn btn-secondary btn-xs"
 					title="View diagram in new page"
-					on:click|stopPropagation={() => viewDiagram()}><i class="far fa-eye mr-2" /> View</button>
+					on:click|stopPropagation={() => viewDiagram()}><i class="far fa-eye mr-1" />View</button>
 
 				<div class="flex-1 overflow-auto">
 					<View />

svelte.config.js

@@ -12,15 +12,13 @@ const config = {
 	],
 	kit: {
 		adapter: adapter({
-			pages: `docs${process.env['BETA'] ? '/beta' : ''}`
+			pages: `docs`
 		}),
 		paths: process.env['DEPLOY']
 			? {
-					base: `/mermaid-live-editor${process.env['BETA'] ? '/beta' : ''}`
+					base: `/mermaid-live-editor`
 			  }
 			: {},
-		// hydrate the <div id="svelte"> element in src/app.html
-		target: '#svelte',
 		trailingSlash: 'ignore',
 		vite: {
 			envPrefix: 'MERMAID_',

tsconfig.json

@@ -1,39 +1,11 @@
 {
-	"compilerOptions": {
-		"moduleResolution": "node",
-		"module": "es2020",
-		"lib": ["es2020", "ESNext", "DOM.Iterable", "DOM"],
-		"target": "es2019",
-		/**
-			svelte-preprocess cannot figure out whether you have a value or a type, so tell TypeScript
-			to enforce using \`import type\` instead of \`import\` for Types.
-			*/
-		"importsNotUsedAsValues": "error",
-		"isolatedModules": true,
-		"resolveJsonModule": true,
-		/**
-			To have warnings/errors of the Svelte compiler at the correct position,
-			enable source maps by default.
-			*/
-		"sourceMap": true,
-		"esModuleInterop": true,
-		"skipLibCheck": true,
-		"forceConsistentCasingInFileNames": true,
-		"baseUrl": ".",
-		"allowJs": true,
-		"checkJs": true,
-		"paths": {
-			"$lib/*": ["src/lib/*"]
-		}
-	},
 	"include": [
 		"src/**/*.d.ts",
-		"src/**/*.js",
 		"src/**/*.ts",
 		"src/**/*.svelte",
 		"cypress/**/*.ts",
 		"cypress/**/*.js",
-		"static/**/*.js",
-		"src/pako.mts"
-	]
+		"static/**/*.js"
+	],
+	"extends": "./.svelte-kit/tsconfig.json"
 }