Professional-grade documentation with MkDocs

[vestrel00]

The previous contents of the GitHub Pages had several problems with it.

1. It does not look that good.
2. It looks *horrible in mobile.
3. It lacks structure (e.g. groupings using directories).
4. It is a nightmare to navigate.
5. It is not searchable.
6. I have to do some manual stuff every time I have to update it.

MkDocs to the rescue!

Luckily, MkDocs is a thing; https://www.mkdocs.org/getting-started/ ❤️

I used the most popular theme (material), which has millions of downloads per month and used by big names; https://github.com/squidfunk/mkdocs-material

The new, professional-grade GitHub Pages 🔥

You and everyone else that is or will be using this library now have access to full, professional-grade documentation!

Here's what it looks like in desktop.

contacts-reborn-docs-desktop.mov

Mobile looks great too!

contacts-reborn-docs-mobile.mov

Please help spread the word 🙏

If you are proud to use this library, please help spread the word. I will eternally be grateful and everyone in the community will too 😁

Please join the discussion; #189

[vestrel00]

If you want to see how I did this, take a look at #190 and #191

[vestrel00]

DARK MODE TOGGLE ENABLED!!!

dark.mode.mp4