Add Mermaid support to documentation and components#284
Open
i-subham23 wants to merge 10 commits intomainfrom
Open
Add Mermaid support to documentation and components#284i-subham23 wants to merge 10 commits intomainfrom
i-subham23 wants to merge 10 commits intomainfrom
Conversation
- Introduced a new Mermaid component for rendering flowcharts in MDX. - Updated `mdx-components.tsx` to include the Mermaid component. - Integrated Mermaid into various documentation pages with flowcharts illustrating API contracts, connection decisions, and chat provider interactions. - Updated dependencies in `package.json` to include Mermaid version 11.13.0. - Configured MDX options to use the `remarkMdxMermaid` plugin for processing Mermaid syntax.
- Updated the Mermaid component to accept an `initialZoom` prop, allowing for customizable zoom levels when rendering charts. - Modified the MermaidContent function to utilize the `initialZoom` prop for setting the initial zoom state. - Adjusted documentation examples to include the `initialZoom` prop for better visualization control in various MDX files.
- Adjusted Mermaid flowchart syntax in the connecting.mdx file to escape newline characters for better rendering. - Enhanced the clarity of decision points in the flowchart by ensuring proper formatting of text labels.
- Changed flowchart syntax in providers.mdx to escape newline characters, enhancing the clarity of decision points. - Updated the flex direction in the MermaidContent component to 'row' for better layout management.
- Added interaction tracking to the MermaidContent component with a new `hasInteracted` state to improve user experience. - Updated zoom and pan functionality to allow for smoother interactions when using the mouse wheel. - Modified instructional text to reflect new interaction methods, enhancing clarity for users. - Made minor formatting adjustments in various MDX files to improve readability and maintain consistency.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
mdx-components.tsxto include the Mermaid component.package.jsonto include Mermaid version 11.13.0.remarkMdxMermaidplugin for processing Mermaid syntax.