Graphql-engine: docs: add click-to-copy button for examples

Created on 25 May 2020  路  8Comments  路  Source: hasura/graphql-engine

It would be nice to have a click-to-copy button for code examples, especially for the SQL code blocks.

docs good first issue help wanted wip

All 8 comments

It might need a script to implement this feature

Can I give this issue a try?

@kzuri Sure

There is a package for this: Sphinx-copybutton

I'll give this one a shot :)

@marionschleifer Hey, I have been working on this, and I see in the whole docs we have $ before inputs and outputs too. If we do that the user might get confused what to copy and what not to copy. Can I remove $ from the output blocks and add OUTPUT above the code block? That way I can match the inputs with regex and provide copy buttons only to the code blocks which are input.
Example:
This is input
$ docker ps

The line(s) below are output
CONTAINER ID IMAGE ... CREATED STATUS PORTS ...
097f58433a2b hasura/graphql-engine ... 1m ago Up 1m 8080->8080/tcp ...
b0b1aac0508d postgres ... 1m ago Up 1m 5432/tcp ...

Hi all,
may i know if there is a way to serve the sphinx documentation over https while testing locally ?

Hasura
Guess that gets the required job done, will be creating a PR soon for the same. Sorry, I guess the mouse pointer is not visible in the gif.

Was this page helpful?
0 / 5 - 0 ratings