huggingface / doc-builder

The package used to build the documentation of our Hugging Face repos
Apache License 2.0
82 stars 34 forks source link

`<Tip>` customization request #170

Open LysandreJik opened 2 years ago

LysandreJik commented 2 years ago

Each repository has its own needs in terms of features; Hugging Face Hub, for example, now requires the versionadded and versionchanged directives. However, these likely take some time to implement.

When working on the huggingface_hub documentation, a workaround that I would have found sufficient is the ability to customize the <Tip> directive to specify different colors.

For example here, the <Tip> has the same color for the versionadded directive:

image

And the raises directive:

image

Ideally, to allow enough time for the design to emerge on doc-builder's side, customizing the <Tip> should be more than enough.

julien-c commented 2 years ago

sounds like a great/simple idea to me