diff --git a/docs/_config.yml b/docs/_config.yml index 4d7bc9746..31f8c6c04 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -85,6 +85,9 @@ navigation: - title: Upgrade Guide url: upgrade-guide.html icon: fas fa-hand-point-up + - title: Contributing Guide + url: contributing.html + icon: fas fa-hands-helping - title: FAQ url: faq.html icon: fas fa-question-circle diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 000000000..b04e6acdd --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,47 @@ +--- +layout: page +title: Contributing Guide +--- + +Contributions are always **welcome and recommended**! Here is how for beginner's: [Get started with open source click here](https://youtu.be/GbqSvJs-6W4) + +1. 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). +2. Installation : + * Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)). + * Clone to your machine + + ```bash + git clone https://github.com/YOUR_USERNAME/AdminLTE.git + ``` + * Create a new branch +3. Compile dist files (Development) : + * To compile the dist files you need Node.js 10 or higher/npm (node package manager) + * Delete ./package-lock.json file + * `npm install` (install npm deps) + * `npm run dev` (developer mode, autocompile with browsersync support for live demo) + * Make your changes only in ./buid Folder OR package.json OR ./dist/js/demo.js OR in any html files which nessary to contribute + * Do not changes in ./dist/css/ AND ./dist/js/ Because its compiled files + * `npm run production` (compile css/js files and test every pages are perfectly working fine, before creating pull request) +4. Create a pull request + +### Online one-click setup for contributing + +You can use Gitpod(an online IDE which is free for Open Source) for working on issues or making Prs. With a single click it will launch a workspace and automatically: + +- clone the `AdminLTE` repo. +- install the dependencies. +- run `yarn dev` to start the server. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) + +### 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) diff --git a/docs/dependencies.md b/docs/dependencies.md index 8f91ba1c1..14a084016 100644 --- a/docs/dependencies.md +++ b/docs/dependencies.md @@ -8,9 +8,9 @@ title: Dependencies & Plugins AdminLTE depends on two main frameworks. The downloadable package contains both of these libraries, so you don't have to manually download them. {: .lead} -- [Bootstrap 4](https://getbootstrap.com/) -- [jQuery 3.3.1+](https://jquery.com/) -- [Popper.js 1.14.7+](https://popper.js.org/) +- [Bootstrap 4.5](https://getbootstrap.com/) +- [jQuery 3.5.1+](https://jquery.com/) +- [Popper.js 1.16.1+](https://popper.js.org/) - [All other plugins are listed below](#plugins) #### Plugins diff --git a/docs/index.md b/docs/index.md index b990bf9c1..23e0cd186 100644 --- a/docs/index.md +++ b/docs/index.md @@ -38,3 +38,7 @@ composer require "almasaeed2010/adminlte=~3.0" ```bash git clone https://github.com/ColorlibHQ/AdminLTE.git ``` + +### From CDN + +[https://www.jsdelivr.com/package/npm/admin-lte](https://www.jsdelivr.com/package/npm/admin-lte) \ No newline at end of file diff --git a/docs/layout.md b/docs/layout.md index ea380d844..7249db42c 100644 --- a/docs/layout.md +++ b/docs/layout.md @@ -21,7 +21,7 @@ The layout consists of four major parts: > You cannot use both layout-boxed and layout-navbar-fixed or layout-footer-fixed at the same time. Anything else can be mixed together. {: .quote-danger} -AdminLTE 3.0 provides a set of options to apply to your main layout. Each one of these classes can be added to the body tag to get the desired goal. +AdminLTE 3.1 provides a set of options to apply to your main layout. Each one of these classes can be added to the body tag to get the desired goal. - Fixed Sidebar: use the class `.layout-fixed` to get a fixed sidebar. - Fixed Navbar: use the class `.layout-navbar-fixed` to get a fixed navbar. @@ -51,7 +51,7 @@ You can also use the following classes for responsive changes with placing #### Color Variations -AdminLTE 3.0 provides a set of color variations to apply to your sidebar (light & dark) & navbar. You can combine any available color with these class prefixes: +AdminLTE 3.1 provides a set of color variations to apply to your sidebar (light & dark) & navbar. You can combine any available color with these class prefixes: - `.navbar-*` - `.sidebar-dark-*`