diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml index 9f501319..5964ff52 100644 --- a/.github/workflows/build-and-test.yml +++ b/.github/workflows/build-and-test.yml @@ -9,6 +9,7 @@ on: - ".github/**" - "images/**" - ".gitignore" + - "*.md" pull_request: branches: [ "master" ] paths-ignore: @@ -16,6 +17,7 @@ on: - ".github/**" - "images/**" - ".gitignore" + - "*.md" jobs: build-macos: diff --git a/README.md b/README.md index 18d484c6..284d7c7f 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ [![maClara](https://img.shields.io/badge/Sponsored%20by-maClara%2C%20LLC-blue?style=plastic&logoColor=blue)](https://maclara-llc.com) -> [!WARNING] The current LibJWT code is under heavy reconstruction and is changing +> [!WARNING] +> The current LibJWT code is under heavy reconstruction and is changing > wildly from the API and ABI of v2 and prior. There's still a lot going on here, > and there are no guarantees that this new API is set in stone. Users beware. diff --git a/doxygen/mainpage.dox b/doxygen/mainpage.dox index cc30228b..6418af2d 100644 --- a/doxygen/mainpage.dox +++ b/doxygen/mainpage.dox @@ -1,10 +1,11 @@ @mainpage Welcome to LibJWT -@warning The current LibJWT code is under heavy reconstruction and is changing -wildly from the API and ABI of v2 and prior. There's still a lot going on here, -and there are no guarantees that this new API is set in stone. Users beware. If -you want to see the older documentation, -[here's the latest](https://libjwt.io/stable) +> [!WARNING] +> The current LibJWT code is under heavy reconstruction and is changing +> wildly from the API and ABI of v2 and prior. There's still a lot going on here, +> and there are no guarantees that this new API is set in stone. Users beware. If +> you want to see the older documentation, +> [here's the latest](https://libjwt.io/stable) @section standards \emoji :bulb: Supported Standards @@ -15,10 +16,11 @@ Standard | RFC | Description ``JWS`` and ``JWE`` | @rfc{7518} | Specific types of JWT ``JWK`` and ``JWKS`` | @rfc{7517} | JSON Web Keys and Sets -@note Throughout this documentation you will see links such as the ones -above to RFC documents. These are relevant to that particular part of the -library and are helpful to understand some of the specific standards that -shaped the development of LibJWT. +> [!NOTE] +> Throughout this documentation you will see links such as the ones +> above to RFC documents. These are relevant to that particular part of the +> library and are helpful to understand some of the specific standards that +> shaped the development of LibJWT. @section building \emoji :construction: Build Prerequisites