Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Setup of Markdown+Mermaid #209

Merged
merged 1 commit into from
Feb 22, 2024
Merged

Initial Setup of Markdown+Mermaid #209

merged 1 commit into from
Feb 22, 2024

Conversation

nikhilkalburgi
Copy link
Contributor

Description

  • The Design for the new PreView Panel
    image
  • Created additional panel for markdown
  • In the design I have included a copy button to export markdown
  • In the components folder we can develop the markdown of all asyncapi objects + mermaid diagram
  • Using markdown-it to translate the markdown to HTML for preview
  • Using @asyncapi/parser to parse and pass to individual functions in ./components folder
  • Added the mermaid script to render mermaid diagrams
  • Need to work for a better UI
  • Info is not fully developed, but needs more development to be done

Tools Used: mermaid.js, markdown-it, @asyncapi/parser

Hi @ivangsa , what do you think about this? also need to decide whether to go for flowchart or classdiagram. Once the setup is accepted, we can start the further developements

Related issue(s)
Partially Resolves #161

Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
@asyncapi-bot
Copy link
Contributor

We require all PRs to follow Conventional Commits specification.
More details 👇🏼

 No release type found in pull request title "Initial Setup of Markdown+Mermaid". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

Copy link

sonarcloud bot commented Feb 22, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@ivangsa
Copy link
Collaborator

ivangsa commented Feb 22, 2024

Good work!
can you collaborate with @josephinoo in creating a template, maybe with ejs, for the markdown content...
maybe including:

  • info
  • servers
  • channels
  • messages
    And also a mermaid diagram for the schemas with relationships for each message (separated)

Copy link
Collaborator

@ivangsa ivangsa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good work!

@ivangsa
Copy link
Collaborator

ivangsa commented Feb 22, 2024

I'm merging this so you can collaborate on this

/rtm

@asyncapi-bot asyncapi-bot merged commit 89335b5 into asyncapi:feature/mermaid-markdown Feb 22, 2024
18 of 19 checks passed
@nikhilkalburgi
Copy link
Contributor Author

Sure @ivangsa

Congrats to you and entire community! for being accepted as GSOC 24 Org.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants