asyncapi / asyncapi/studio

"Open with Studio" button for Markdown files.

Open
#218 39 comments 6 reactions 0 assignees View on GitHub
enhancement keep-open
Dominant language
TypeScript
Stars
213
Forks
143
Avg merge
13h 57m
Merged PRs (30d)
11

Description

#### Reason/Context
I'm lately advocating for using Studio whenever I want to add a link to an AsyncAPI file in a Markdown file such as Readmes. Thanks to the `?url=` query param, Studio can load most of files (yes, not all of them, see https://github.com/asyncapi/studio/issues/127).

I think it would be awesome to create a new design for a button that says "Open with Studio", with the AsyncAPI logo on the left or similar.

#### Description

To design a button that says something like "Open with Studio", with the AsyncAPI logo somewhere that people can use for linking to AsyncAPI files in their Markdown/HML files.

Some examples:

- ![](https://run.pstmn.io/button.svg)
- ![](https://www.deploytodo.com/do-btn-blue.svg)
- ![](https://www.netlify.com/img/deploy/button.svg)

cc @mcturco @alequetzalli @boyney123

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked button examples and the issue's description of Markdown/HTML usage. Done means a new "Open with Studio" button design, including AsyncAPI branding, that people can use to link AsyncAPI files to Studio.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, markdown
Domain
design, documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.