update docs (#3511)
This commit is contained in:
Jouni Vanhanen
GitHub
parent
ce8e76684c
commit
4a43243ea7
82
README.md
82
README.md
|
|
@ -21,56 +21,68 @@ prices. Visit <https://adminlte.io/premium> for more information.
|
|||
SCSS has been used to increase code customizability.
|
||||
|
||||
## Quick start
|
||||
|
||||
There are multiple ways to install AdminLTE.
|
||||
|
||||
### Download & Changelog:
|
||||
|
||||
Always Recommended to download from GitHub latest release [AdminLTE 3](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 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18) / [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1).
|
||||
|
||||
### Grab from [jsdelivr](https://www.jsdelivr.com/package/npm/admin-lte) CDN :
|
||||
|
||||
## 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
|
||||
<script src="https://cdn.jsdelivr.net/npm/admin-lte@3.1/dist/js/adminlte.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/admin-lte@3.0.5/dist/js/adminlte.min.js"></script>
|
||||
```
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/admin-lte@3.1/dist/css/adminlte.min.css">
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/admin-lte@3.0.5/dist/css/adminlte.min.css">
|
||||
```
|
||||
|
||||
### Using The Command Line:
|
||||
|
||||
_**Important Note**: To install it via npm/Yarn, you need at least Node.js 10 or higher._
|
||||
#### Via npm
|
||||
```bash
|
||||
npm install admin-lte@^3.0.5 --save
|
||||
```
|
||||
#### Via Yarn
|
||||
```bash
|
||||
yarn add admin-lte@^3.0.5
|
||||
```
|
||||
#### Via Composer
|
||||
```bash
|
||||
composer require "almasaeed2010/adminlte=~3.0.5"
|
||||
```
|
||||
#### Via Git
|
||||
```bash
|
||||
git clone https://github.com/ColorlibHQ/AdminLTE.git
|
||||
```
|
||||
|
||||
- **Via npm**
|
||||
|
||||
```bash
|
||||
npm install admin-lte@^3.1 --save
|
||||
```
|
||||
|
||||
- **Via Yarn**
|
||||
|
||||
```bash
|
||||
yarn add admin-lte@^3.1
|
||||
```
|
||||
|
||||
- **Via Composer**
|
||||
|
||||
```bash
|
||||
composer require "almasaeed2010/adminlte=~3.1"
|
||||
```
|
||||
|
||||
- **Via Git**
|
||||
|
||||
Clone to your machine
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ColorlibHQ/AdminLTE.git
|
||||
```
|
||||
## Unstable 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
|
||||
<script src="https://cdn.jsdelivr.net/npm/admin-lte@3.1.0-rc/dist/js/adminlte.min.js"></script>
|
||||
```
|
||||
```html
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/admin-lte@3.1.0-rc/dist/css/adminlte.min.css">
|
||||
```
|
||||
### Using The Command Line:
|
||||
_**Important Note**: To install it via npm/Yarn, you need at least Node.js 10 or higher._
|
||||
#### Via npm
|
||||
```bash
|
||||
npm install admin-lte@^3.1.0-rc --save
|
||||
```
|
||||
#### Via Yarn
|
||||
```bash
|
||||
yarn add admin-lte@^3.1.0-rc
|
||||
```
|
||||
#### Via Composer
|
||||
```bash
|
||||
composer require "almasaeed2010/adminlte=~3.1.0-rc"
|
||||
```
|
||||
#### Via Git
|
||||
```bash
|
||||
git clone https://github.com/ColorlibHQ/AdminLTE.git
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
|
|
|
|||
71
docs/index.md
vendored
71
docs/index.md
vendored
|
|
@ -3,49 +3,66 @@ layout: page
|
|||
title: Introduction
|
||||
---
|
||||
|
||||
AdminLTE can be installed using multiple methods. Pick your favorite method from the list below. Please be sure to check the dependencies section before continuing.
|
||||
## Quick start
|
||||
There are multiple ways to install AdminLTE.
|
||||
|
||||
### Download & Changelog:
|
||||
Always Recommended to download from GitHub latest release [AdminLTE 3](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 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18) / [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1).
|
||||
|
||||
### Download from GitHub
|
||||
|
||||
Visit the releases section on GitHub and download the [latest release](https://github.com/ColorlibHQ/AdminLTE/releases).
|
||||
|
||||
|
||||
### Grab from [jsdelivr](https://github.com/ColorlibHQ/AdminLTE/releases/latest) CDN :
|
||||
|
||||
## 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
|
||||
<script src="https://cdn.jsdelivr.net/npm/admin-lte@3.1/dist/js/adminlte.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/admin-lte@3.0.5/dist/js/adminlte.min.js"></script>
|
||||
```
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/admin-lte@3.1/dist/css/adminlte.min.css">
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/admin-lte@3.0.5/dist/css/adminlte.min.css">
|
||||
```
|
||||
|
||||
|
||||
### Command Line
|
||||
|
||||
#### Via NPM
|
||||
|
||||
### Using The Command Line:
|
||||
_**Important Note**: To install it via npm/Yarn, you need at least Node.js 10 or higher._
|
||||
#### Via npm
|
||||
```bash
|
||||
npm install admin-lte@^3.1 --save
|
||||
npm install admin-lte@^3.0.5 --save
|
||||
```
|
||||
|
||||
#### Via Yarn
|
||||
|
||||
```bash
|
||||
yarn add admin-lte@^3.1
|
||||
yarn add admin-lte@^3.0.5
|
||||
```
|
||||
|
||||
#### Via Composer
|
||||
|
||||
```bash
|
||||
composer require "almasaeed2010/adminlte=~3.1"
|
||||
composer require "almasaeed2010/adminlte=~3.0.5"
|
||||
```
|
||||
#### Via Git
|
||||
```bash
|
||||
git clone https://github.com/ColorlibHQ/AdminLTE.git
|
||||
```
|
||||
|
||||
## Unstable 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
|
||||
<script src="https://cdn.jsdelivr.net/npm/admin-lte@3.1.0-rc/dist/js/adminlte.min.js"></script>
|
||||
```
|
||||
```html
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/admin-lte@3.1.0-rc/dist/css/adminlte.min.css">
|
||||
```
|
||||
### Using The Command Line:
|
||||
_**Important Note**: To install it via npm/Yarn, you need at least Node.js 10 or higher._
|
||||
#### Via npm
|
||||
```bash
|
||||
npm install admin-lte@^3.1.0-rc --save
|
||||
```
|
||||
#### Via Yarn
|
||||
```bash
|
||||
yarn add admin-lte@^3.1.0-rc
|
||||
```
|
||||
#### Via Composer
|
||||
```bash
|
||||
composer require "almasaeed2010/adminlte=~3.1.0-rc"
|
||||
```
|
||||
|
||||
#### Via Git
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ColorlibHQ/AdminLTE.git
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue