bridgetownrb / bridgetown-cloudinary

Embed or access images with transformations using Cloudinary and Bridgetown
MIT License
6 stars 3 forks source link

Minor README updates #6

Closed RichNSD closed 1 year ago

RichNSD commented 1 year ago

Note Blocks

GFM actually supports specially-formatted 'quote' blocks for Warnings and Notes, which can be made like this:

> __Warning__<br />
> This is a Warning.

This is some boring, regular text.

> __Note__<br />
> This is a Note.

Warning While the hard <br /> break is necessary for things like README documents and Wikis, it is not required for things like Discussion Posts, Issues, and Pull Requests. So make sure you preview them before you post.

As an example, that Warning block does not have a hard break following Warning.

It took me forever to figure out how to make them (because apparently there's no documentation for it at all) and I figured you'd enjoy them.

Additional Syntax Highlighting

I always appreciate when creators take the time to properly format their documentation so that everyone else can more easily understand it, so thanks for being thorough.

However I noticed the Liquid and ERB examples you added were done in basic code spans, which made them a little difficult to follow on a phone with word wrapping.

If you didn't know, liquid and erb are both valid declarations for code blocks, and they include HTML highlighting in addition to the template syntax.

Let me know if you have any questions about this, and I hope it helps- and I'm looking forward to trying out the plugin soon. 😎

jaredcwhite commented 1 year ago

Thanks @RichNSD, that does look much nicer!

RichNSD commented 1 year ago

Any time, glad I could help. 👍🏻