search

febo / pinocchio

Create Solana programs with no dependencies attached
Apache License 2.0
92 stars 19 forks source link

docs: Using Github callout in README #25

Closed kquirapas closed 1 month ago

kquirapas commented 1 month ago

Change

Used a Github callout in the README

Screenshot 2024-10-12 at 7 48 56 AM

Can change it to the one you most prefer from the ones below:

Screenshot 2024-10-12 at 7 49 42 AM

kquirapas commented 1 month ago

A

[!WARNING] Body

[!IMPORTANT] Body

Might be suitable

febo commented 1 month ago

It currently does not use the GitHub annotation since the README.md is the same one that gets publishes on crates.io, which does not support it. If we were to use it, it will not be formatted and it will render as [!WARNING].

febo commented 1 month ago

Here is an example of how it looked when using GitHub annotations: https://crates.io/crates/pinocchio/0.1.0

You can see that [!IMPORTANT] does not render properly on crates.io unfortunately.

febo commented 1 month ago

Closing this as it seems we cannot use it at the moment.