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

feature: code snippet component #80

Open
cold-briu opened this issue Oct 12, 2023 · 0 comments
Open

feature: code snippet component #80

cold-briu opened this issue Oct 12, 2023 · 0 comments

Comments

@cold-briu
Copy link
Contributor

"Working with commands is one of the key elements of the docs experience.
It always comes to 3 things:

What it does

What's the command I need to copy-paste

What's the expected result.

Currently the docs hub is using for wrapping all of the above.

What about creating a component that includes these aspect in a more friendly way?
ie: Something like the graphql recipes component made by Sarah but with the following features:

The component is a card.

The card title describes the behavior of the component

The card contains a "copy button" that copies the command but not the '$'

The card includes a section showing the output"

We can format outputs differently than inputs

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

No branches or pull requests

1 participant