|
1 | 1 | <!DOCTYPE html> |
2 | 2 | <!-- |
3 | 3 | * CoreUI - Free Bootstrap Admin Template |
4 | | -* @version v4.0.0-beta.0 |
| 4 | +* @version v4.0.0-beta.1 |
5 | 5 | * @link https://coreui.io |
6 | 6 | * Copyright (c) 2021 creativeLabs Łukasz Holeczek |
7 | 7 | * Licensed under MIT (https://coreui.io/license) |
|
274 | 274 | <div class="card-body"> |
275 | 275 | <h1>Usage</h1> |
276 | 276 | <h2 id="tooling-setup">Tooling setup<a class="anchorjs-link" aria-label="Anchor" data-anchorjs-icon="#" href="#tooling-setup" style="padding-left: 0.375em;"></a></h2> |
277 | | - <p>CoreUI Admin Template uses <a href="https://docs.npmjs.com/misc/scripts/">npm scripts</a> for its build system. Our <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0-beta.0/package.json">package.json</a> includes convenient methods for working with the framework, including compiling code, running tests, and more.</p> |
| 277 | + <p>CoreUI Admin Template uses <a href="https://docs.npmjs.com/misc/scripts/">npm scripts</a> for its build system. Our <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0-beta.1/package.json">package.json</a> includes convenient methods for working with the framework, including compiling code, running tests, and more.</p> |
278 | 278 | <p>To use our build system and run template locally, you’ll need a copy of CoreUI’s source files and Node. Follow these steps and you should be ready to rock:</p> |
279 | 279 | <ol> |
280 | 280 | <li><a href="https://nodejs.org/en/download/">Download and install Node.js</a>, which we use to manage our dependencies.</li> |
281 | | - <li>Either <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/archive/v4.0.0-beta.0.zip">download CoreUI’s sources</a> or fork <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template">CoreUI’s repository</a>.</li> |
282 | | - <li>Navigate to the root <code>/coreui-free-bootstrap-admin-template</code> directory and run <code>npm install</code> to install our local dependencies listed in <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0-beta.0/package.json">package.json</a>.</li> |
| 281 | + <li>Either <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/archive/v4.0.0-beta.1.zip">download CoreUI’s sources</a> or fork <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template">CoreUI’s repository</a>.</li> |
| 282 | + <li>Navigate to the root <code>/coreui-free-bootstrap-admin-template</code> directory and run <code>npm install</code> to install our local dependencies listed in <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0-beta.1/package.json">package.json</a>.</li> |
283 | 283 | </ol> |
284 | 284 | <p>When completed, you’ll be able to run the various commands provided from the command line.</p> |
285 | 285 | <h2 id="using-npm-scripts">Using npm scripts<a class="anchorjs-link" aria-label="Anchor" data-anchorjs-icon="#" href="#using-npm-scripts" style="padding-left: 0.375em;"></a></h2> |
286 | | - <p>Our <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0-beta.0/package.json">package.json</a> includes numerous tasks for developing the project. Run <code>npm run</code> to see all the npm scripts in your terminal. <strong>Primary tasks include:</strong></p> |
| 286 | + <p>Our <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0-beta.1/package.json">package.json</a> includes numerous tasks for developing the project. Run <code>npm run</code> to see all the npm scripts in your terminal. <strong>Primary tasks include:</strong></p> |
287 | 287 | <table class="table"> |
288 | 288 | <thead> |
289 | 289 | <tr> |
@@ -316,7 +316,7 @@ <h2 id="sass">Sass<a class="anchorjs-link" aria-label="Anchor" data-anchorjs-ico |
316 | 316 | <p>Dart Sass uses a rounding precision of 10 and for efficiency reasons does not allow adjustment of this value. We don’t lower this precision during further processing of our generated CSS, such as during minification, but if you chose to do so we recommend maintaining a precision of at least 6 to prevent issues with browser rounding.</p> |
317 | 317 | <h2 id="autoprefixer">Autoprefixer<a class="anchorjs-link" aria-label="Anchor" data-anchorjs-icon="#" href="#autoprefixer" style="padding-left: 0.375em;"></a></h2> |
318 | 318 | <p>CoreUI for Bootstrap uses <a href="https://github.com/postcss/autoprefixer">Autoprefixer</a> (included in our build process) to automatically add vendor prefixes to some CSS properties at build time. Doing so saves us time and code by allowing us to write key parts of our CSS a single time while eliminating the need for vendor mixins like those found in v3.</p> |
319 | | - <p>We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0-beta.0/.browserslistrc">.browserslistrc</a> for details.</p> |
| 319 | + <p>We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See <a href="https://github.com/coreui/coreui-free-bootstrap-admin-template/blob/v4.0.0-beta.1/.browserslistrc">.browserslistrc</a> for details.</p> |
320 | 320 | <h2 id="rtlcss">RTLCSS<a class="anchorjs-link" aria-label="Anchor" data-anchorjs-icon="#" href="#rtlcss" style="padding-left: 0.375em;"></a></h2> |
321 | 321 | <p>CoreUI for Bootstrap uses <a href="https://rtlcss.com/">RTLCSS</a> to process compiled CSS and convert them to RTL – basically replacing horizontal direction aware properties (eg. <code>padding-left</code>) with their opposite. It allows us only write our CSS a single time and make minor tweaks using RTLCSS <a href="https://rtlcss.com/learn/usage-guide/control-directives/">control</a> and <a href="https://rtlcss.com/learn/usage-guide/value-directives/">value</a> directives.</p> |
322 | 322 | <h2 id="local-documentation">Local documentation<a class="anchorjs-link" aria-label="Anchor" data-anchorjs-icon="#" href="#local-documentation" style="padding-left: 0.375em;"></a></h2> |
|
0 commit comments