Feature/mkdocs

[abhishekpcnair]

#49 Ported from sphinx to mkdocs material theme

[ramnes]

Hey, thanks for your work! Is the result visible somewhere?

One important thing: we shouldn't have the mkdocs output (minified files and such) in the repository. Instead we should use a GitHub action and push that output in a branch.

You can have a look here at how we've done it for notion-sdk-py, specifically the .github/workflows/docs.yml file: ramnes/notion-sdk-py#30

[abhishekpcnair]

Noted I will fix them, but the docs with sphinx right now is hosted in readthedocs right? If so, then something like this should work https://about.readthedocs.com/tools/mkdocs/

[abhishekpcnair]

Not very familiar with the GH, but after some trial and error, here it is
https://abhishekpcnair.github.io/mongo-thingy/

The order of sections need some work though, but this could be a good starting point

[coveralls]

coverage: 100.0%. remained the same
when pulling 176c97b on abhishekpcnair:feature/mkdocs
into 879fd7c on Refty:master.