Summary Files Commits Branches @commit @diff @stats
path: root / docs / getting-started.html
diff options
context:
space:
mode:
Commit3e837ba52cb27fbb34f3139ebc53faea5847a95c (patch)
Author
 Yan Zhu <picturepan2@hotmail.com>
2017-08-17 22:59:52 +0800
Committer
 Yan Zhu <picturepan2@hotmail.com>
2017-08-17 22:59:52 +0800
Filesd3510659e63ffee1a998f5c1bb77e2ac2b808d9d /docs/getting-started.html
Spectre-Dark-Gruvbox-3e837ba52cb27fbb34f3139ebc53faea5847a95c.tar
Spectre-Dark-Gruvbox-3e837ba52cb27fbb34f3139ebc53faea5847a95c.tar.gz
Spectre-Dark-Gruvbox-3e837ba52cb27fbb34f3139ebc53faea5847a95c.zip
Parent41ec3e49d63ea45d8aee4f26eeccfedaa20a7f7d (diff)
Add more Docs content
1 files changed, 20 insertions, 7 deletions
-rw-r--r--docs/getting-started.html27
diff --git a/docs/getting-started.html b/docs/getting-started.html
index c74b0a2..0ae3376 100644
--- a/docs/getting-started.html
+++ b/docs/getting-started.html
@@ -254,7 +254,7 @@
<div id="introduction" class="container">
<h3 class="s-title"><a href="#introduction" class="anchor" aria-hidden="true">#</a>Introduction</h3>
<div class="docs-note">
- <p><strong>Spectre.css</strong> is a lightweight and responsive and modern CSS framework for faster and extensible development.</p>
+ <p><strong>Spectre.css</strong> is a lightweight, responsive and modern CSS framework for faster and extensible development.</p>
<p>Spectre provides basic styles for typography and elements, flexbox based responsive layout system, CSS components and utilities with best practice coding and consistent design language.</p>
</div>
</div>
@@ -266,8 +266,8 @@
</div>
<div class="docs-note">
<h5>Install manually</h5>
- <p>Download the compiled and minified <a href="https://github.com/picturepan2/spectre/tree/master/docs/dist" target="_blank">Spectre CSS file</a> (~10KB min+gzip):</p>
- <p><a href="https://github.com/picturepan2/spectre/tree/master/docs/dist" target="_blank" class="btn btn-primary">Download Spectre.css</a></p>
+ <p>Download the compiled and minified <a href="https://github.com/picturepan2/spectre/releases" target="_blank">Spectre CSS file</a> (core ~10KB min+gzip):</p>
+ <p><a href="https://github.com/picturepan2/spectre/releases" target="_blank" class="btn btn-primary">Download Spectre.css</a></p>
<p>Include <code>spectre.css</code> located in <strong>/docs/dist</strong> in your website or Web app &lt;head&gt;. Also, you can add <code>spectre-icons.css</code> and <code>spectre-exp.css</code> accordingly.</p>
</div>
@@ -315,18 +315,29 @@
<div id="compiling" class="container">
<h3 class="s-title"><a href="#comiling" class="anchor" aria-hidden="true">#</a>Custom version</h3>
<div class="docs-note">
- <p>Spectre uses <a href="http://gulpjs.com/" target="_blank">Gulp</a> for compiling CSS. You can customize your version of Spectre.css by editing LESS files in <code>/src</code> directory or removing unneeded components from <code>spectre.less</code>, <code>spectre-exp.less</code> and <code>spectre-icons.less</code>.</p>
+ <p>You can customize your version of Spectre.css by editing LESS files in <code>/src</code> directory or removing unneeded components from <code>.less</code> source files.</p>
+ <p><a href="https://github.com/picturepan2/spectre/" target="_blank" class="btn btn-primary">Spectre.css Source Code</a></p>
+ </div>
+ <h4 id="compiling-steps" class="s-subtitle">Compiling CSS</h4>
+ <div class="docs-note">
+ <p>Spectre uses <a href="http://gulpjs.com/" target="_blank">Gulp</a> for compiling CSS. Firstly you need to <a href="https://www.npmjs.com/get-npm" target="_blank">install NPM</a>, which is used to manage Gulp and other dependencies.</p>
<p>Then, you can build the CSS file from the command line:</p>
<ol>
<li>Navigate to the root directory of Spectre.</li>
<li>Run <code>npm install</code>. NPM will install all dev dependencies as listed in package.json.</li>
- <li>When completed, run <code>gulp build</code> to compile LESS to CSS and minify files.</li>
+ <li>When completed, run <code>gulp build</code> task to compile LESS to CSS and minify files.</li>
<li>You can find compiled CSS files in <code>/dist</code> directory.</li>
</ol>
- <p>You can watch file changes and rebuild CSS files by using <code>gulp watch</code>.</p>
+ <p>All available Gulp tasks:</p>
+ <ul>
+ <li><code>gulp build</code> - compile LESS to CSS and minify files (default)</li>
+ <li><code>gulp docs</code> - compile Docs related files</li>
+ <li><code>gulp watch</code> - watch file changes and re-compile CSS files</li>
+ </ul>
</div>
-<!-- file structure -->
+ <h4 id="compiling-gulptasks" class="s-subtitle">Folder Structure</h4>
+<!-- folder structure -->
<pre class="code"><code>spectre/
├── dist/ <span class="com">// Build folder (Git ignored)</span>
│ ├── spectre-exp.css
@@ -445,12 +456,14 @@
</div>
</div>
</div>
+
<h5 id="variables-sizes" class="s-subtitle">Sizes</h5>
<div class="docs-note">
<p>The default REM (root em) size in Spectre.css is <code>20px</code>. </p>
<p>Please note in the Chinese/Japanese/Korean version, Chrome uses 12px as default minimum font size. That is why Spectre sets rem default html font size to <code>20px</code>, which is relatively easy to calculate. </p>
<p>Spectre uses <code>4px</code> as the unit size. Sizes of components are based on the unit size. </p>
</div>
+
<h5 id="variables-custom-prefix" class="s-subtitle">Custom prefix</h5>
<div class="docs-note">
<p>There is also a way to add custom prefix to all CSS classes. You can use <a href="https://www.npmjs.com/package/gulp-css-prefix" target="_blank">gulp-css-prefix</a> plugin and add a new Gulp task to enable it. </p>