diff --git a/README.md b/README.md index 2d7be9d..5920f3f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # ccil-kbw.github.io + Documentation of the Droid developed for the Centre Khalid Ben Walid in Laval + +## MkDocs + +This documentation is built using [MkDocs](https://www.mkdocs.org/). + +### Installation + +```bash +pip install -r requirements.txt +``` + +### Development + +```bash +mkdocs serve - +``` + diff --git a/docs/assets/header-0.png b/docs/assets/header-0.png new file mode 100644 index 0000000..8a4cad8 Binary files /dev/null and b/docs/assets/header-0.png differ diff --git a/docs/assets/header-droid-0.png b/docs/assets/header-droid-0.png new file mode 100644 index 0000000..ac79768 Binary files /dev/null and b/docs/assets/header-droid-0.png differ diff --git a/docs/droid/intro.md b/docs/droid/intro.md index e9e48ab..5cea3e0 100644 --- a/docs/droid/intro.md +++ b/docs/droid/intro.md @@ -1,4 +1,35 @@ - + + +

+ KBW Blueprint +

+

+ The Droid was born in the basement of KBW. It was developed to serve the Ummah. +

Feel free to Copy and Clone this Droid. Contributing back to the main project will be greatly appreciated but absolutely optional. +

Everything we do is for the sake of Allah only. + +

+ +

+ + Latest Commit + + + Test + + + Coverage + + + Package version + +

+ +--- + +_Features Documentation is outdated, please refer to the main repository for the latest documentation. We will do our best to update this._ ## Masjid's Droid - Introduction The Masjid's Droid is the Application used at Khaled Ben Walid to serve the needs of the Administration. All features are Open to be used by anyone, diff --git a/docs/index.md b/docs/index.md index 9967a72..68aa4f5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,42 @@ -# Masjid's Droid Documentation + -This page serves as a centralized place to document all tools developed by the Khaled Ben Walid team. +

+ KBW Blueprint +

+

+ KBW Tech is dedicated to write the simplest solutions for the sake of Allah. +

-For more information please visit [github organisation](https://github.com/ccil-kbw) +

+ + Latest Commit + + + Test + + + Coverage + + + Package version + +

-Our IT organization does its best to keep all development as transparent as possible. Our main focus is the privacy and the security of our users. All code can be copied and used but can't be sold commercially. +--- -Masjid's Droid was original written by [@serafdev](https://twitter.com/serafdev) to serve the needs of the beloved community of [Khaled Ben Walid](https://ccil-kbw.com) but is intended to benefit the whole beloved Ummah, East to West. Feel free to give us a star on GitHub, and leave us a comment there! \ No newline at end of file +**Documentation**: https://ccil-kbw.github.io + +**Source Code**: https://github.com/ccil-kbw/robot + +--- + +_**Qu'ran and Sunnah**_: We aim to make all our projects compliant with the Qu'ran and Sunnah. + +_**Simplicity**_: We aim to make all our projects easy to manage and maintain, even for non-technical users. + +_**Open Source**_: We aim to make all our projects open source to help other communities and developers. + +_**Community**_: We aim to make all our projects community-driven, so that the community can help us improve our +projects. diff --git a/docs/website_docs.md b/docs/website_docs.md index f9f8b23..14f6532 100644 --- a/docs/website_docs.md +++ b/docs/website_docs.md @@ -1,3 +1,5 @@ +_This is an outdated documentation of the Website, we have migrated to Wordpress, more to come._ + ## Introduction Our Masjid's Website is Open Source and is a Fork of the [Chirpy Jekyll theme](https://github.com/cotes2020/jekyll-theme-chirpy#readme), it is currently deployed on GitHub Pages to have free hosting, but overall it's simply a Frontend Static page so can be deployed anywhere.