From f69272d50407501ff971aa4d2f7bc7f1529289bc Mon Sep 17 00:00:00 2001 From: REJack Date: Sun, 28 Jul 2019 22:36:12 +0200 Subject: [PATCH] added new docs pages - components/direct-chat - browser-support - implementations - faq - license --- docs/browser-support.md | 28 ++ docs/components/direct-chat.md | 807 +++++++++++++++++++++++++++++++++ docs/faq.md | 15 + docs/implementations.md | 32 ++ docs/license.md | 20 + 5 files changed, 902 insertions(+) create mode 100644 docs/browser-support.md create mode 100644 docs/components/direct-chat.md create mode 100644 docs/faq.md create mode 100644 docs/implementations.md create mode 100644 docs/license.md diff --git a/docs/browser-support.md b/docs/browser-support.md new file mode 100644 index 000000000..65b27309f --- /dev/null +++ b/docs/browser-support.md @@ -0,0 +1,28 @@ +--- +layout: page +title: Browser Support +--- + +AdminLTE comes with the same browser support as Bootstrap 4. + +> ##### Excerpt from Bootstrap's official Documentation! +> Bootstrap supports the __latest, stable releases__ of all major browsers and platforms. On Windows, __we support Internet Explorer 10-11 / Microsoft Edge__. +> +> For more details [look here](https://getbootstrap.com/docs/4.3/getting-started/browsers-devices/#supported-browsers). + +You can find our supported range of browsers and their versions in [our .browserslistrc file](https://github.com/ColorlibHQ/AdminLTE/blob/v3-dev/.browserslistrc): +``` +# https://github.com/browserslist/browserslist#readme + +>= 1% +last 1 major version +not dead +Chrome >= 45 +Firefox >= 38 +Edge >= 12 +Explorer >= 10 +iOS >= 9 +Safari >= 9 +Android >= 4.4 +Opera >= 30 +``` diff --git a/docs/components/direct-chat.md b/docs/components/direct-chat.md new file mode 100644 index 000000000..9b013da4d --- /dev/null +++ b/docs/components/direct-chat.md @@ -0,0 +1,807 @@ +--- +layout: page +title: Direct Chat Components +--- + +The direct chat widget extends the card component to create a beautiful chat interface. This widget consists of a required messages pane and an __optional__ contacts pane. Examples: + +
+
+
+
+

Direct Chat

+
+ 3 + + + +
+
+
+
+
+
+ Alexander Pierce + 23 Jan 2:00 pm +
+ message user image +
+ Is this template really for free? That's unbelievable! +
+
+
+
+ Sarah Bullock + 23 Jan 2:05 pm +
+ message user image +
+ You better believe it! +
+
+
+
+ Alexander Pierce + 23 Jan 5:37 pm +
+ message user image +
+ Working with AdminLTE on a great new app! Wanna join? +
+
+
+
+ Sarah Bullock + 23 Jan 6:10 pm +
+ message user image +
+ I would love to. +
+
+
+ +
+ +
+
+
+
+
+ + + + +
+
+
+
+
+
+
+
+

Direct Chat

+
+ 3 + + + +
+
+
+
+
+
+ Alexander Pierce + 23 Jan 2:00 pm +
+ message user image +
+ Is this template really for free? That's unbelievable! +
+
+
+
+ Sarah Bullock + 23 Jan 2:05 pm +
+ message user image +
+ You better believe it! +
+
+
+
+ Alexander Pierce + 23 Jan 5:37 pm +
+ message user image +
+ Working with AdminLTE on a great new app! Wanna join? +
+
+
+
+ Sarah Bullock + 23 Jan 6:10 pm +
+ message user image +
+ I would love to. +
+
+
+ +
+ +
+
+
+
+
+ + + + +
+
+
+
+
+
+ +```html + + + +
+
+

Direct Chat

+
+ 3 + + + +
+
+ +
+ +
+ +
+
+ Alexander Pierce + 23 Jan 2:00 pm +
+ + message user image + +
+ Is this template really for free? That's unbelievable! +
+ +
+ + +
+
+ Sarah Bullock + 23 Jan 2:05 pm +
+ + message user image + +
+ You better believe it! +
+ +
+ + +
+
+ Alexander Pierce + 23 Jan 5:37 pm +
+ + message user image + +
+ Working with AdminLTE on a great new app! Wanna join? +
+ +
+ + +
+
+ Sarah Bullock + 23 Jan 6:10 pm +
+ + message user image + +
+ I would love to. +
+ +
+ +
+ + +
+ + +
+ +
+ +
+
+
+ + + + +
+
+
+ +
+ +``` +{: .max-height-300} + +##### Outline Direct Chat +{: .text-bold .text-dark .mt-5} + +Of course you can use direct chat with a outline card by adding the class `.card-outline` to the card. Here are a couple of examples: + +
+
+
+
+

Direct Chat

+
+ 3 + + + +
+
+
+
+
+
+ Alexander Pierce + 23 Jan 2:00 pm +
+ message user image +
+ Is this template really for free? That's unbelievable! +
+
+
+
+ Sarah Bullock + 23 Jan 2:05 pm +
+ message user image +
+ You better believe it! +
+
+
+
+ Alexander Pierce + 23 Jan 5:37 pm +
+ message user image +
+ Working with AdminLTE on a great new app! Wanna join? +
+
+
+
+ Sarah Bullock + 23 Jan 6:10 pm +
+ message user image +
+ I would love to. +
+
+
+ +
+ +
+
+
+
+
+ + + + +
+
+
+
+
+
+
+
+

Direct Chat

+
+ 3 + + + +
+
+
+
+
+
+ Alexander Pierce + 23 Jan 2:00 pm +
+ message user image +
+ Is this template really for free? That's unbelievable! +
+
+
+
+ Sarah Bullock + 23 Jan 2:05 pm +
+ message user image +
+ You better believe it! +
+
+
+
+ Alexander Pierce + 23 Jan 5:37 pm +
+ message user image +
+ Working with AdminLTE on a great new app! Wanna join? +
+
+
+
+ Sarah Bullock + 23 Jan 6:10 pm +
+ message user image +
+ I would love to. +
+
+
+ +
+ +
+
+
+
+
+ + + + +
+
+
+
+
+
diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 000000000..afc41a676 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,15 @@ +--- +layout: page +title: FAQ +--- + +#### Can AdminLTE be used with Wordpress? +AdminLTE is an HTML template that can be used for any purpose. However, it is not made to be easily installed on Wordpress. It will require some effort and enough knowledge of the Wordpress script to do so. + +#### Is there an integration guide for PHP frameworks such as Yii or Symfony? +Short answer, no. However, there are forks and tutorials around the web that provide info on how to integrate with many different frameworks. There are even versions of AdminLTE that are integrated with jQuery ajax, AngularJS and/or MVC5 ASP .NET. + + diff --git a/docs/implementations.md b/docs/implementations.md new file mode 100644 index 000000000..805d7eb32 --- /dev/null +++ b/docs/implementations.md @@ -0,0 +1,32 @@ +--- +layout: page +title: Implementations +--- + +Thanks to many of AdminLTE users, there are multiple implementations of the template for easy integration with back-end frameworks. The following are some of them: + + +##### AdminLTE v2.4 +{: .text-bold .text-dark .mt-3} +- [Laravel-AdminLTE](https://github.com/jeroennoten/Laravel-AdminLTE) by [Jeroen Noten](https://github.com/jeroennoten) +- [Laravel 5 package](https://github.com/acacha/adminlte-laravel) by [Sergi Tur Badenas](https://github.com/acacha) +- [Yii 2](https://github.com/dmstr/yii2-adminlte-asset) by [Tobias Munk](https://github.com/schmunk42) + +##### AdminLTE v2.3 +{: .text-bold .text-dark .mt-3} +- [Symfony](https://github.com/avanzu/AdminThemeBundle) by [Marc Bach](https://github.com/avanzu) +- [lte-rails](https://github.com/racketlogger/lte-rails) by [Carlos at RacketLogger](https://github.com/racketlogger) + +##### AdminLTE v2.2 +{: .text-bold .text-dark .mt-3} +- [Persian RTL](https://github.com/mmdsharifi/AdminLTE-RTL) by [Mohammad Sharifi](https://github.com/mmdsharifi) + +##### AdminLTE v2.1 +{: .text-bold .text-dark .mt-3} +- [adminlte2-rails](https://github.com/nicolas-besnard/adminlte2-rails) by [Nicolas Besnard](https://github.com/nicolas-besnard) + + + +> ##### Note! +> These implementations are not supported by ColorlibHQ. However, they do provide a good example of how to integrate AdminLTE into different frameworks. For the latest release of AdminLTE, please visit our [repository](https://github.com/ColorlibHQ/AdminLTE/) or [website](https://adminlte.io). +{: .quote-danger} diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 000000000..d75aacd8a --- /dev/null +++ b/docs/license.md @@ -0,0 +1,20 @@ +--- +layout: page +title: License +--- + +AdminLTE is an open source project that is licensed under the [MIT license](http://opensource.org/licenses/MIT). This allows you to do pretty much anything you want as long as you include the copyright in "all copies or substantial portions of the Software." Attribution is not required (though very much appreciated). + +
What You Are Allowed To Do With AdminLTE
+- Use in commercial projects. +- Use in personal/private projects. +- Modify and change the work. +- Distribute the code. +- Sublicense: incorporate the work into something that has a more restrictive license. + +
What You Are Not Allowed To Do With AdminLTE
+- The work is provided "as is". You may not hold the author liable. + +
What You Must Do When Using AdminLTE
+- Include the license notice in all copies of the work. +- Include the copyright notice in all copies of the work. This applies to everything except the notice in the footer of the HTML example pages.