Thalhammer / jwt-cpp

A header only library for creating and validating json web tokens in c++
https://thalhammer.github.io/jwt-cpp/
MIT License
865 stars 235 forks source link

Update documentation layout #202

Closed prince-chrismc closed 2 years ago

prince-chrismc commented 2 years ago

Preview: https://prince-chrismc.github.io/jwt-cpp/

I noticed some reference with traits were not included and once I got started I saw there are improved "modern" layout so I'd love any thoughts if this is a good direction 🙏

I also find the landing README a bit long so I moved two sections into a separate page. Plus added the things that came out from the "using wolfssl" cconverstation from #171

prince-chrismc commented 2 years ago

where can I learn this sorcery?

Google 😆 https://www.google.com/search?q=doxygen+themes and then checking the first page for good options

The one I found have an easy installation https://jothepro.github.io/doxygen-awesome-css/index.html#autotoc_md8

It only takes 3 lines

https://github.com/Thalhammer/jwt-cpp/blob/559520b4070bd676fc6ced09b5109235834b755a/.github/workflows/documentation.yml#L12-L13

and

https://github.com/Thalhammer/jwt-cpp/blob/559520b4070bd676fc6ced09b5109235834b755a/Doxyfile#L1195

prince-chrismc commented 2 years ago

One more styling question

How do you feel about the diagram that are being generated? Example: https://prince-chrismc.github.io/jwt-cpp/structjwt_1_1algorithm_1_1es256k.html

Thalhammer commented 2 years ago

One more styling question

How do you feel about the diagram that are being generated? Example: https://prince-chrismc.github.io/jwt-cpp/structjwt_1_1algorithm_1_1es256k.html

Look good to me