Assorted Markdown tweaks (#2750)

This commit is contained in:
XhmikosR 2020-06-01 11:33:08 +03:00 committed by GitHub
parent 532707221b
commit 7edd752b6b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 68 additions and 61 deletions

View file

@ -24,9 +24,9 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem. If applicable, add screenshots to help explain your problem.
**Environment (please complete the following information):** **Environment (please complete the following information):**
- AdminLTE Version: [e.g. v3.0.0] - AdminLTE Version: [e.g. v3.0.0]
- Operating System: [e.g. macOS Catalina] - Operating System: [e.g. macOS Catalina]
- Browser (Version): [e.g. Chrome (Latest)] - Browser (Version): [e.g. Chrome (Latest)]
**Additional context** **Additional context**
Add any other context about the problem here. Add any other context about the problem here.

123
README.md
View file

@ -1,5 +1,4 @@
Introduction # Introduction
============
[![npm version](https://img.shields.io/npm/v/admin-lte/latest.svg)](https://www.npmjs.com/package/admin-lte) [![npm version](https://img.shields.io/npm/v/admin-lte/latest.svg)](https://www.npmjs.com/package/admin-lte)
[![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte) [![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](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)** **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 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 Presentation"](https://adminlte.io/AdminLTE3.png "AdminLTE Presentation") !["AdminLTE Presentation"](https://adminlte.io/AdminLTE3.png "AdminLTE Presentation")
**AdminLTE** has been carefully coded with clear comments in all of its JS, SCSS and HTML files. **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. SCSS has been used to increase code customizability.
Installation ## Installation
------------
There are multiple ways to install AdminLTE. There are multiple ways to install AdminLTE.
#### Download: ### Download:
Download from [GitHub releases](https://github.com/ColorlibHQ/AdminLTE/releases). 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__ - **Via npm**
```bash
npm install admin-lte@^3.0 --save
```
__Via Yarn__ ```bash
```bash npm install admin-lte@^3.0 --save
yarn add admin-lte@^3.0 ```
```
__Via Composer__ - **Via Yarn**
```bash
composer require "almasaeed2010/adminlte=~3.0"
```
__Via Git__ ```bash
- Clone to your machine yarn add admin-lte@^3.0
``` ```
git clone https://github.com/ColorlibHQ/AdminLTE.git
``` - **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 Visit the [online documentation](https://adminlte.io/docs/3.0/) for the most
updated guide. Information will be added on a weekly basis. updated guide. Information will be added on a weekly basis.
Browser Support ## Browser Support
---------------
- IE 10+ - IE 10+
- Firefox (latest) - Firefox (latest)
- Chrome (latest) - Chrome (latest)
@ -67,55 +71,58 @@ Browser Support
- Opera (latest) - Opera (latest)
- Microsoft Edge (latest) - Microsoft Edge (latest)
Contribution ## Contributions
------------
Contribution are always **welcome and recommended**! Here is how: Contributions are always **welcome and recommended**! Here is how:
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)). - 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 - Create a new branch
- Make your changes - Make your changes
- Create a pull request - Create a pull request
#### Compile dist files ### Compile dist files
To compile the dist files you need nodejs/npm, clone/download the repo then:
To compile the dist files you need Node.js/npm, clone/download the repo then:
1. `npm install` (install npm deps) 1. `npm install` (install npm deps)
2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo) 2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo)
3. `npm run production` (compile css/js files) 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. - 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. - 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. - Contributions are only accepted through GitHub pull requests.
- Finally, contributed code must work in all supported browsers (see above for browser support). - Finally, contributed code must work in all supported browsers (see above for browser support).
License ## 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 AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT).
reserves the right to change the license of future releases. 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) - [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 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18)
- [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1) - [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 Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog
Image Credits ## Image Credits
-------------
[Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
[Graphicsfuel](https://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/) - [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/) - [Pickaface](https://pickaface.net/)
- [Unsplash](https://unsplash.com/)
[Unsplash](https://unsplash.com/) - [Uifaces](http://uifaces.com/)
[Uifaces](http://uifaces.com/)