Create Documentation Using MkDocs

[Hamster45105]

This PR adds proper documentation using Material for MkDocs.

Most of the docs have just been copied over from the previous .md files with some small improvements, however with MkDocs, there is lots more possibilities for customisation in the future. Using MkDocs will make it easier for developers to use FlightRadarAPI.

Any suggestions for improvement would be appreciated!

Demo Site

Things to note

• If you decide to merge, the site needs to be enabled via GitHub pages. To do this:

1. Wait until initial run of deploy-docs.yml is complete
2. Go to the repos settings
3. Go to the pages section
4. Set source to Deploy from a branch
5. Set branch to gh-pages
6. Leave folder as /root
7. Click save
8. This will deploy the site.

• The website link on the repo should be changed to https://JeanExtreme002.github.io/FlightRadarAPI/

• The wiki should probably be deleted

Future Improvements

While these docs are an improvement on the previous method of using .md files in the repo, they are in a very basic form. Here are some future improvements that could be made:

1. Implement versioning
2. Add all API options to the docs (some functions that are available are not currently recorded in the docs)
3. Design a better logo and favicon
4. Move different functions onto different pages or find another way to make it more organised rather than having all functions just pasted onto one page, which makes it difficult to read
5. Take advantage of the many other powerful features available in Material for MkDocs (adding comments to code, improved navigation etc...)

[JeanExtreme002]

Hi @Hamster45105!

First and foremost, I would like to thank you for your contribution. What you did here was incredible! I have no words to describe how grateful I am. The documentation is very well organized and very beautiful. ❤️

I don't have much knowledge in technologies for creating documentation yet, but I intended to start studying and improving the project's documentation later this year. I'm glad you showed up to help.

As for the suggestions for improvements, I will take them into consideration. I still need to learn how to use MkDocs, so it may take some time for me to start editing the files — even because I'm a little busy dealing with some university projects.

I reviewed your PR and I'm merging it now. 😃

Again, thank you very much for your huge contribution to the project. 💯

[Hamster45105]

Hi, thank you for your fast response! I'm glad I could help out in such a meaningful way and thanks for maintaining such an amazing open source project.

Also, good luck with your university studies!

[JeanExtreme002]

I just published the new version at Pypi and NPM ❤️

As for MkDocs, I did some research on it, and it doesn't seem too difficult to learn. I'll dedicate some time to study and practice with it later this week.