From 11f7f426cb45515ae8b1b137c7596ca09f444a49 Mon Sep 17 00:00:00 2001 From: Steph <35910788+huynhicode@users.noreply.github.com> Date: Fri, 28 Feb 2025 08:05:42 -0800 Subject: [PATCH] verbiage updates --- .../setup/interfaces/mermaid.ParseOptions.md | 22 ------------------- .../mermaid/src/docs/.vitepress/config.ts | 2 +- packages/mermaid/src/docs/index.md | 16 +++++++------- 3 files changed, 9 insertions(+), 31 deletions(-) delete mode 100644 docs/config/setup/interfaces/mermaid.ParseOptions.md diff --git a/docs/config/setup/interfaces/mermaid.ParseOptions.md b/docs/config/setup/interfaces/mermaid.ParseOptions.md deleted file mode 100644 index 717e35565..000000000 --- a/docs/config/setup/interfaces/mermaid.ParseOptions.md +++ /dev/null @@ -1,22 +0,0 @@ -> **Warning** -> -> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. -> -> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.ParseOptions.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.ParseOptions.md). - -# Interface: ParseOptions - -[mermaid](../modules/mermaid.md).ParseOptions - -## Properties - -### suppressErrors - -• `Optional` **suppressErrors**: `boolean` - -If `true`, parse will return `false` instead of throwing error when the diagram is invalid. -The `parseError` function will not be called. - -#### Defined in - -[packages/mermaid/src/types.ts:59](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L59) diff --git a/packages/mermaid/src/docs/.vitepress/config.ts b/packages/mermaid/src/docs/.vitepress/config.ts index a40b50fed..5e861a59e 100644 --- a/packages/mermaid/src/docs/.vitepress/config.ts +++ b/packages/mermaid/src/docs/.vitepress/config.ts @@ -104,7 +104,7 @@ function nav() { ], }, { - text: '💻 Live Editor', + text: '💻 Open Editor', link: 'https://mermaid.live', }, ]; diff --git a/packages/mermaid/src/docs/index.md b/packages/mermaid/src/docs/index.md index 218757b10..bb9a6e9e3 100644 --- a/packages/mermaid/src/docs/index.md +++ b/packages/mermaid/src/docs/index.md @@ -15,23 +15,23 @@ hero: alt: Mermaid actions: - theme: brand - text: Get Started - link: /intro/ + text: Try Mermaid Editor + link: https://www.mermaidchart.com/play - theme: alt - text: View on GitHub + text: Build with Mermaid link: https://github.com/mermaid-js/mermaid + - theme: alt + text: Learn more + link: https://mermaid.js.org/intro/ features: - title: ➕ Easy to use! - details: Easily create and render detailed diagrams and charts with the Mermaid Live Editor. - link: https://mermaid.live/ + details: Easily create diagrams and charts with the Mermaid Editor. + link: https://www.mermaidchart.com/play - title: 🧩 Integrations available! details: Use Mermaid with your favorite applications, check out the integrations list. link: ../../ecosystem/integrations-community.md - title: 🏆 Award winning! details: 2019 JavaScript Open Source Award winner for "The Most Exciting Use of Technology". link: https://osawards.com/javascript/2019 - - title: 🥰 Mermaid + Mermaid Chart - details: Mermaid Chart is a major supporter of the Mermaid project. - link: https://www.mermaidchart.com/ ---