FuelLabs / FuelLabs/docs-hub

feature: code snippet component

Open
#80 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
124
Forks
78
Avg merge
22h 9m
Merged PRs (30d)
6

Description

"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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.