Assorted Markdown tweaks (#2750)
This commit is contained in:
XhmikosR
GitHub
parent
532707221b
commit
7edd752b6b
|
|
@ -24,9 +24,9 @@ A clear and concise description of what you expected to happen.
|
|||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Environment (please complete the following information):**
|
||||
- AdminLTE Version: [e.g. v3.0.0]
|
||||
- Operating System: [e.g. macOS Catalina]
|
||||
- Browser (Version): [e.g. Chrome (Latest)]
|
||||
- AdminLTE Version: [e.g. v3.0.0]
|
||||
- Operating System: [e.g. macOS Catalina]
|
||||
- Browser (Version): [e.g. Chrome (Latest)]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
|
|
|||
123
README.md
123
README.md
|
|
@ -1,5 +1,4 @@
|
|||
Introduction
|
||||
============
|
||||
# Introduction
|
||||
|
||||
[](https://www.npmjs.com/package/admin-lte)
|
||||
[](https://packagist.org/packages/almasaeed2010/adminlte)
|
||||
|
|
@ -10,56 +9,61 @@ Highly customizable and easy to use. Fits many screen resolutions from small mob
|
|||
|
||||
**Preview on [AdminLTE.io](https://adminlte.io/themes/v3)**
|
||||
|
||||
Looking for Premium Templates?
|
||||
------------------------------
|
||||
## Looking for Premium Templates?
|
||||
|
||||
AdminLTE.io just opened a new premium templates page. Hand picked to ensure the best quality and the most affordable
|
||||
prices. Visit https://adminlte.io/premium for more information.
|
||||
prices. Visit <https://adminlte.io/premium> for more information.
|
||||
|
||||
|
||||
|
||||
**AdminLTE** has been carefully coded with clear comments in all of its JS, SCSS and HTML files.
|
||||
SCSS has been used to increase code customizability.
|
||||
|
||||
Installation
|
||||
------------
|
||||
## Installation
|
||||
|
||||
There are multiple ways to install AdminLTE.
|
||||
|
||||
#### Download:
|
||||
### Download:
|
||||
|
||||
Download from [GitHub releases](https://github.com/ColorlibHQ/AdminLTE/releases).
|
||||
|
||||
#### Using The Command Line:
|
||||
### Using The Command Line:
|
||||
|
||||
_**Important Note**: To install it via NPM/Yarn, you need at least Node.js 10 or higher._
|
||||
_**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 --save
|
||||
```
|
||||
- **Via npm**
|
||||
|
||||
__Via Yarn__
|
||||
```bash
|
||||
yarn add admin-lte@^3.0
|
||||
```
|
||||
```bash
|
||||
npm install admin-lte@^3.0 --save
|
||||
```
|
||||
|
||||
__Via Composer__
|
||||
```bash
|
||||
composer require "almasaeed2010/adminlte=~3.0"
|
||||
```
|
||||
- **Via Yarn**
|
||||
|
||||
__Via Git__
|
||||
- Clone to your machine
|
||||
```
|
||||
git clone https://github.com/ColorlibHQ/AdminLTE.git
|
||||
```
|
||||
```bash
|
||||
yarn add admin-lte@^3.0
|
||||
```
|
||||
|
||||
- **Via Composer**
|
||||
|
||||
```bash
|
||||
composer require "almasaeed2010/adminlte=~3.0"
|
||||
```
|
||||
|
||||
- **Via Git**
|
||||
|
||||
Clone to your machine
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ColorlibHQ/AdminLTE.git
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Visit the [online documentation](https://adminlte.io/docs/3.0/) for the most
|
||||
updated guide. Information will be added on a weekly basis.
|
||||
|
||||
Browser Support
|
||||
---------------
|
||||
## Browser Support
|
||||
|
||||
- IE 10+
|
||||
- Firefox (latest)
|
||||
- Chrome (latest)
|
||||
|
|
@ -67,55 +71,58 @@ Browser Support
|
|||
- Opera (latest)
|
||||
- Microsoft Edge (latest)
|
||||
|
||||
Contribution
|
||||
------------
|
||||
Contribution are always **welcome and recommended**! Here is how:
|
||||
## Contributions
|
||||
|
||||
Contributions are always **welcome and recommended**! Here is how:
|
||||
|
||||
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
|
||||
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git```
|
||||
- Clone to your machine
|
||||
|
||||
```bash
|
||||
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
|
||||
```
|
||||
|
||||
- Create a new branch
|
||||
- Make your changes
|
||||
- Create a pull request
|
||||
|
||||
#### Compile dist files
|
||||
To compile the dist files you need nodejs/npm, clone/download the repo then:
|
||||
### Compile dist files
|
||||
|
||||
To compile the dist files you need Node.js/npm, clone/download the repo then:
|
||||
|
||||
1. `npm install` (install npm deps)
|
||||
2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo)
|
||||
3. `npm run production` (compile css/js files)
|
||||
|
||||
#### Contribution Requirements:
|
||||
### Contribution Requirements:
|
||||
|
||||
- When you contribute, you agree to give a non-exclusive license to AdminLTE.io to use that contribution in any context as we (AdminLTE.io) see appropriate.
|
||||
- If you use content provided by another party, it must be appropriately licensed using an [open source](https://opensource.org/licenses) license.
|
||||
- Contributions are only accepted through GitHub pull requests.
|
||||
- Finally, contributed code must work in all supported browsers (see above for browser support).
|
||||
|
||||
License
|
||||
-------
|
||||
AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT). AdminLTE.io
|
||||
reserves the right to change the license of future releases.
|
||||
## License
|
||||
|
||||
AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT).
|
||||
AdminLTE.io reserves the right to change the license of future releases.
|
||||
|
||||
## Latest Release
|
||||
|
||||
Latest Release
|
||||
---------------
|
||||
- [AdminLTE 3](https://github.com/ColorlibHQ/AdminLTE/releases/latest)
|
||||
|
||||
Legacy Releases
|
||||
---------------
|
||||
## Legacy Releases
|
||||
|
||||
- [AdminLTE 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18)
|
||||
- [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1)
|
||||
|
||||
Change log
|
||||
----------
|
||||
## Changelog
|
||||
|
||||
Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog
|
||||
|
||||
Image Credits
|
||||
-------------
|
||||
[Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
|
||||
## Image Credits
|
||||
|
||||
[Graphicsfuel](https://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
|
||||
|
||||
[Pickaface](https://pickaface.net/)
|
||||
|
||||
[Unsplash](https://unsplash.com/)
|
||||
|
||||
[Uifaces](http://uifaces.com/)
|
||||
- [Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
|
||||
- [Graphicsfuel](https://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
|
||||
- [Pickaface](https://pickaface.net/)
|
||||
- [Unsplash](https://unsplash.com/)
|
||||
- [Uifaces](http://uifaces.com/)
|
||||
|
|
|
|||
Loading…
Reference in a new issue