From f8b2dfbdc5e9a67a90f2e39f0d4c00865ef33240 Mon Sep 17 00:00:00 2001 From: Daniel <50356015+danny007in@users.noreply.github.com> Date: Thu, 27 Apr 2023 17:10:47 +0530 Subject: [PATCH] docs intro and browser support --- src/html/components/dashboard/_sidenav.astro | 14 ++++- .../components/docs/browser-support/index.md | 22 +++++++ .../components/docs/introduction/index.md | 35 +++++++++++ src/html/pages/docs/browser-support.astro | 58 +++++++++++++++++++ src/html/pages/docs/color-mode.astro | 16 ++--- src/html/pages/docs/index.astro | 58 +++++++++++++++++++ src/scss/_app-sidebar.scss | 10 +++- src/scss/_docs.scss | 4 +- src/scss/_variables-dark.scss | 2 +- src/scss/_variables.scss | 2 +- 10 files changed, 204 insertions(+), 17 deletions(-) create mode 100644 src/html/components/docs/browser-support/index.md create mode 100644 src/html/components/docs/introduction/index.md create mode 100644 src/html/pages/docs/browser-support.astro create mode 100644 src/html/pages/docs/index.astro diff --git a/src/html/components/dashboard/_sidenav.astro b/src/html/components/dashboard/_sidenav.astro index 21ff2d382..00169c830 100644 --- a/src/html/components/dashboard/_sidenav.astro +++ b/src/html/components/dashboard/_sidenav.astro @@ -191,7 +191,19 @@ const htmlPath = convertPathToHtml(path)
Installation
+ +Browser Support
+ +Color Mode
diff --git a/src/html/components/docs/browser-support/index.md b/src/html/components/docs/browser-support/index.md new file mode 100644 index 000000000..200d1320d --- /dev/null +++ b/src/html/components/docs/browser-support/index.md @@ -0,0 +1,22 @@ +AdminLTE comes with the same browser support as Bootstrap 5. + +> ##### Excerpt from Bootstrap's official Documentation! +> Bootstrap supports the __latest, stable releases__ of all major browsers and platforms. +> +> For more details [look here](https://getbootstrap.com/docs/5.0/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/master/.browserslistrc): + +``` +# https://github.com/browserslist/browserslist#readme + +>= 0.5% +last 2 major versions +not dead +Chrome >= 60 +Firefox >= 60 +Firefox ESR +iOS >= 12 +Safari >= 12 +not Explorer <= 11 +``` diff --git a/src/html/components/docs/introduction/index.md b/src/html/components/docs/introduction/index.md new file mode 100644 index 000000000..84e9a7d0c --- /dev/null +++ b/src/html/components/docs/introduction/index.md @@ -0,0 +1,35 @@ +## Quick start +There are multiple ways to install AdminLTE. + +### Download & Changelog: +Always Recommended to download from GitHub latest release [AdminLTE 4](https://github.com/ColorlibHQ/AdminLTE/releases/latest) for bug free and latest features.\ +Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog.\ +Legacy Releases are [AdminLTE 3](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v3.2.0) / [AdminLTE 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18) / [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1). + +## Stable release +### Grab from [jsdelivr](https://www.jsdelivr.com/package/npm/admin-lte) CDN: +_**Important Note**: You needed to add separately cdn links for plugins in your project._ +```html + +``` +```html + +``` +### Using The Command Line: +_**Important Note**: To install it via npm/Yarn, you need at least Node.js 14 or higher._ +#### Via npm +```bash +npm install admin-lte@4.0.0-alpha1 --save +``` +#### Via Yarn +```bash +yarn add admin-lte@4.0.0-alpha1 +``` +#### Via Composer +```bash +composer require "almasaeed2010/adminlte=4.0.0-alpha1" +``` +#### Via Git +```bash +git clone https://github.com/ColorlibHQ/AdminLTE.git +``` diff --git a/src/html/pages/docs/browser-support.astro b/src/html/pages/docs/browser-support.astro new file mode 100644 index 000000000..6ed5cda2f --- /dev/null +++ b/src/html/pages/docs/browser-support.astro @@ -0,0 +1,58 @@ +--- +import Head from "@components/_head.astro"; +import Footer from "@components/dashboard/_footer.astro"; +import Topbar from "@components/dashboard/_topbar.astro"; +import BrowserSupport from "@components/docs/browser-support/index.md"; +import Sidenav from "@components/dashboard/_sidenav.astro"; +import Scripts from "@components/_scripts.astro"; +const title = "Browser Support | AdminLTE 4"; +const path = '../../../dist' +const mainPage = "browser-support"; +const page = "docs"; +--- + + + + +