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.

Sign up for GitHub

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

Jump to bottom

chore(website): add basic markdown functionality #1401

Closed
wants to merge 5 commits into from
Closed

chore(website): add basic markdown functionality #1401

wants to merge 5 commits into from

Conversation

Shurtu-gal
Copy link
Contributor

Description

  • Currently trying to integrate docs

Related issue(s)
#1161

@netlify
Copy link

netlify bot commented Jun 11, 2023 •
edited
Loading

✅ Deploy Preview for modelina ready!

Name Link
🔨 Latest commit 757afb6
🔍 Latest deploy log https://app.netlify.com/sites/modelina/deploys/64e5f1b5909454000804ea03
😎 Deploy Preview https://deploy-preview-1401--modelina.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sonarcloud
Copy link

sonarcloud bot commented Jun 11, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 2 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@Shurtu-gal
Copy link
Contributor Author

Shurtu-gal commented Jun 11, 2023 •
edited
Loading

@jonaslagoni I have made a very basic markdown rendering functionality.
Can you guide me towards how you want the design to be?
Also I guess we have to add certain things in markdown itself for better descriptions in headers as well as make it mdx renderable.

jonaslagoni
jonaslagoni reviewed Jun 12, 2023
View reviewed changes
Copy link
Member

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

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

You might have to change the docs i.e. add some metadata: https://github.com/asyncapi/website/blob/ee8617ead0b04803daea9c286f75df13de312d1c/pages/docs/reference/index.md?plain=1#L1

Same with adding sections: https://github.com/asyncapi/website/blob/master/pages/docs/reference/_section.md

Feel free to adapt the docs as needed 🙂

@Shurtu-gal
Copy link
Contributor Author

Sure, but it will take some time, I guess. @jonaslagoni.
Meanwhile, do you have some design in your mind regarding the docs page?

@jonaslagoni
Copy link
Member

I was thinking similar to the examples 🤔

But thats not a hard ask, feel free to make your own impression and decision 🤞😄

@Shurtu-gal
Copy link
Contributor Author

Sure let me see what I can whip up then.

@jonaslagoni
Copy link
Member

Hey @Shurtu-gal, any update here? How far along are you and do you think you can finish it or need someone else to take over?

@sonarcloud
Copy link

sonarcloud bot commented Aug 23, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot E 1 Security Hotspot
Code Smell A 14 Code Smells

No Coverage information No Coverage information
1.3% 1.3% Duplication

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

@Shurtu-gal Shurtu-gal closed this Sep 27, 2023
@Shurtu-gal Shurtu-gal mentioned this pull request Sep 27, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonaslagoni jonaslagoni jonaslagoni left review comments

@devilkiller-ag devilkiller-ag Awaiting requested review from devilkiller-ag devilkiller-ag will be requested when the pull request is marked ready for review devilkiller-ag is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Shurtu-gal @jonaslagoni