Skip to content

Commit

Permalink
Use GitHub alerts Markdown syntax [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
jgarber623 committed Mar 17, 2024
1 parent bbc06fa commit a7586b6
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ response.mime_type #=> String
response.uri #=> HTTP::URI
```

💡 **Note:** `Webmention::Response` objects may return a variety of status codes that will vary depending on the endpoint's capabilities and the success or failure of the request. See [the Webmention spec](https://www.w3.org/TR/webmention/) for more on status codes on their implications. A `Webmention::Response` responding affirmatively to `ok?` _may_ also have a non-successful HTTP status code (e.g. `404 Not Found`).
> [!NOTE]
> `Webmention::Response` objects may return a variety of status codes that will vary depending on the endpoint's capabilities and the success or failure of the request. See [the Webmention spec](https://www.w3.org/TR/webmention/) for more on status codes on their implications. A `Webmention::Response` responding affirmatively to `ok?` _may_ also have a non-successful HTTP status code (e.g. `404 Not Found`).
## Sending multiple webmentions

Expand Down Expand Up @@ -93,7 +94,8 @@ urls = Webmention.mentioned_urls("https://jgarber.example/post/100")

When parsing HTML documents, webmention-client-ruby will find the first [h-entry](https://microformats.org/wiki/h-entry) and search its markup for URLs. If no h-entry is found, the parser will search the document's `<body>`.

💡 **Note:** Links pointing to the supplied URL (or those with internal fragment identifiers) will be rejected. You may wish to additionally filter the results returned by `Webmention.mentioned_urls` before sending webmentions.
> [!NOTE]
> Links pointing to the supplied URL (or those with internal fragment identifiers) will be rejected. You may wish to additionally filter the results returned by `Webmention.mentioned_urls` before sending webmentions.
## Verifying a webmention

Expand Down Expand Up @@ -141,7 +143,8 @@ verification.verify_vouch?
verification.vouch_mentions_source?
```

💡 **Note:** `Webmention.verify_webmention` parses HTML documents using the same rules outlined in [Discovering mentioned URLs](#discovering-mentioned-urls).
> [!NOTE]
> `Webmention.verify_webmention` parses HTML documents using the same rules outlined in [Discovering mentioned URLs](#discovering-mentioned-urls).
## Exception Handling

Expand Down

0 comments on commit a7586b6

Please sign in to comment.