diff options
Update Docs anchor
1 files changed, 19 insertions, 19 deletions
| -rw-r--r-- | docs/getting-started.html | 38 |
diff --git a/docs/getting-started.html b/docs/getting-started.html index e7a99a7..45c464e 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -130,13 +130,13 @@ <div class="off-canvas-content"> <div class="docs-content" id="content"> <div class="container" id="introduction"> - <h3 class="s-title"><a class="anchor" href="#introduction" aria-hidden="true">#</a>Introduction</h3> + <h3 class="s-title">Introduction<a class="anchor" href="#introduction" aria-hidden="true">#</a></h3> <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, pure CSS components and utilities with best practice coding and consistent design language.</p> </div> <div class="container" id="installation"> - <h3 class="s-title"><a class="anchor" href="#installation" aria-hidden="true">#</a>Installation</h3> + <h3 class="s-title">Installation<a class="anchor" href="#installation" aria-hidden="true">#</a></h3> <div class="docs-ad"> <div class="hide-md text-center"> <script async="" src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script> @@ -149,7 +149,7 @@ </div> </div> <p>There are 5 ways to get started with Spectre CSS framework in your projects. You can either install manually, from CDN or use package managers.</p> - <h4 class="s-subtitle" id="install-manually"><a class="anchor" href="#install-manually" aria-hidden="true">#</a>Install manually</h4> + <h4 class="s-subtitle" id="install-manually">Install manually<a class="anchor" href="#install-manually" aria-hidden="true">#</a></h4> <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 class="btn btn-primary" href="https://github.com/picturepan2/spectre/releases" target="_blank">Download Spectre.css</a></p> <p>Include <code>spectre.css</code> located in <strong>/dist</strong> in your website or Web app <head>. Also, you can add <code>spectre-icons.css</code> and <code>spectre-exp.css</code> accordingly.</p> @@ -157,23 +157,23 @@ <span class="hljs-tag"><<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"spectre-exp.min.css"</span>></span> <span class="hljs-tag"><<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"spectre-icons.min.css"</span>></span> </code></pre> - <h4 class="s-subtitle" id="install-cdn"><a class="anchor" href="#install-cdn" aria-hidden="true">#</a>Install from CDN</h4> + <h4 class="s-subtitle" id="install-cdn">Install from CDN<a class="anchor" href="#install-cdn" aria-hidden="true">#</a></h4> <p>Alternatively, you can use the <a href="https://unpkg.com/" target="_blank">unpkg</a> or <a href="https://cdnjs.com/libraries/spectre.css" target="_blank">cdnjs</a> CDN to load compiled Spectre.css.</p> <pre class="code" data-lang="HTML"><code><span class="hljs-tag"><<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"https://unpkg.com/spectre.css/dist/spectre.min.css"</span>></span> <span class="hljs-tag"><<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"https://unpkg.com/spectre.css/dist/spectre-exp.min.css"</span>></span> <span class="hljs-tag"><<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"https://unpkg.com/spectre.css/dist/spectre-icons.min.css"</span>></span> </code></pre> - <h4 class="s-subtitle" id="install-npm"><a class="anchor" href="#install-npm" aria-hidden="true">#</a>Install with NPM</h4> + <h4 class="s-subtitle" id="install-npm">Install with NPM<a class="anchor" href="#install-npm" aria-hidden="true">#</a></h4> <pre class="code" data-lang="Bash"><code>npm install spectre.css --save </code></pre> - <h4 class="s-subtitle" id="install-yarn"><a class="anchor" href="#install-yarn" aria-hidden="true">#</a>Install with Yarn</h4> + <h4 class="s-subtitle" id="install-yarn">Install with Yarn<a class="anchor" href="#install-yarn" aria-hidden="true">#</a></h4> <pre class="code" data-lang="Bash"><code>yarn add spectre.css </code></pre> - <h4 class="s-subtitle" id="install-bower"><a class="anchor" href="#install-bower" aria-hidden="true">#</a>Install from Bower</h4> + <h4 class="s-subtitle" id="install-bower">Install from Bower<a class="anchor" href="#install-bower" aria-hidden="true">#</a></h4> <pre class="code" data-lang="Bash"><code>bower install spectre.css --save</code></pre> </div> <div class="container" id="custom"> - <h3 class="s-title"><a class="anchor" href="#custom" aria-hidden="true">#</a>Custom version</h3> + <h3 class="s-title">Custom version<a class="anchor" href="#custom" aria-hidden="true">#</a></h3> <div class="docs-ad docs-ad-sidebar text-center"> <script id="_carbonads_js" async="" type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CK7DTKQW&placement=picturepan2githubio"></script> </div> @@ -181,7 +181,7 @@ <p><a class="btn btn-primary" href="https://github.com/picturepan2/spectre/" target="_blank">Sass Source Code</a></p> <p>If you are looking for Less version of Spectre.css, please switch to <code>Less</code> branch.</p> <p><a class="btn" href="https://github.com/picturepan2/spectre/tree/less" target="_blank">Less Branch</a></p> - <h4 class="s-subtitle" id="compiling"><a class="anchor" href="#compiling" aria-hidden="true">#</a>Compiling CSS</h4> + <h4 class="s-subtitle" id="compiling">Compiling CSS<a class="anchor" href="#compiling" aria-hidden="true">#</a></h4> <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> @@ -196,7 +196,7 @@ <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> - <h4 class="s-subtitle" id="importing"><a class="anchor" href="#importing" aria-hidden="true">#</a>Importing Sass</h4> + <h4 class="s-subtitle" id="importing">Importing Sass<a class="anchor" href="#importing" aria-hidden="true">#</a></h4> <p>It is recommended to customize Spectre by importing Sass source files to your projects. In this way, you can keep Spectre up to date without conflicts, since Spectre code and your custom code are separate.</p> <ul> <li>First, create your own project and install Spectre via <a href="#installation">NPM or other package managers</a>.</li> @@ -219,7 +219,7 @@ @<span class="hljs-keyword">import</span> <span class="hljs-string">"node_modules/spectre.css/src/buttons"</span>; @<span class="hljs-keyword">import</span> <span class="hljs-string">"node_modules/spectre.css/src/forms"</span>; </code></pre> - <h4 class="s-subtitle" id="folders"><a class="anchor" href="#folders" aria-hidden="true">#</a>Folder structure</h4> + <h4 class="s-subtitle" id="folders">Folder structure<a class="anchor" href="#folders" aria-hidden="true">#</a></h4> <pre class="code"><code>spectre/ ├── <span class="hljs-built_in">dist</span>/ <span class="hljs-comment">// Build folder</span> │ ├── spectre-<span class="hljs-built_in">exp</span>.css @@ -262,9 +262,9 @@ ├── <span class="hljs-keyword">package</span>.json └── ... </code></pre> - <h4 class="s-subtitle" id="variables"><a class="anchor" href="#variables" aria-hidden="true">#</a>Variables</h4> + <h4 class="s-subtitle" id="variables">Variables<a class="anchor" href="#variables" aria-hidden="true">#</a></h4> <p>Spectre.css is designed with consistent design language. You can use your own variables to create your new or match existing design. All variables in <code>_variables.scss</code> include <code>!default</code> flag. You can redefine the variables to override the values.</p> - <h4 class="s-subtitle" id="variables-colors"><a class="anchor" href="#variables-colors" aria-hidden="true">#</a>Variables - Colors</h4> + <h4 class="s-subtitle" id="variables-colors">Variables - Colors<a class="anchor" href="#variables-colors" aria-hidden="true">#</a></h4> <div class="columns"> <div class="column col-3 col-md-6"> <div class="docs-color" style="background:#5755d9;color:#fff;"> @@ -343,7 +343,7 @@ </div> </div> </div> - <h4 class="s-subtitle" id="variables-buttons"><a class="anchor" href="#variables-buttons" aria-hidden="true">#</a>Variables - Button mixins</h4> + <h4 class="s-subtitle" id="variables-buttons">Variables - Button mixins<a class="anchor" href="#variables-buttons" aria-hidden="true">#</a></h4> <p>There are 2 button variant mixins in <code>_mixins.scss</code> to generate different color variants.</p> <ul> <li>@mixin button-variant(<code>$color</code>: $primary-color);</li> @@ -359,11 +359,11 @@ @<span class="hljs-keyword">include</span> button-outline-variant(<span class="hljs-variable">$success-color</span>); } </code></pre> - <h4 class="s-subtitle" id="variables-sizes"><a class="anchor" href="#variables-sizes" aria-hidden="true">#</a>Variables - Sizes</h4> + <h4 class="s-subtitle" id="variables-sizes">Variables - Sizes<a class="anchor" href="#variables-sizes" aria-hidden="true">#</a></h4> <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> - <h4 class="s-subtitle" id="variables-custom-prefix"><a class="anchor" href="#variables-custom-prefix" aria-hidden="true">#</a>Variables - Custom prefix</h4> + <h4 class="s-subtitle" id="variables-custom-prefix">Variables - Custom prefix<a class="anchor" href="#variables-custom-prefix" aria-hidden="true">#</a></h4> <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> <pre class="code" data-lang="Bash"><code>npm install gulp-css-prefix </code></pre> @@ -379,10 +379,10 @@ gulp.task(<span class="hljs-string">'prefix'</span>, <span class="hljs-function" <p>After you compile your version of Spectre in the /dist, run <code>gulp prefix</code> in the directory of Spectre.</p> </div> <div class="container" id="accessibility"> - <h3 class="s-title"><a class="anchor" href="#accessibility" aria-hidden="true">#</a>Accessibility</h3> + <h3 class="s-title">Accessibility<a class="anchor" href="#accessibility" aria-hidden="true">#</a></h3> </div> <div class="container" id="browers"> - <h3 class="s-title"><a class="anchor" href="#browers" aria-hidden="true">#</a>Browser support</h3> + <h3 class="s-title">Browser support<a class="anchor" href="#browers" aria-hidden="true">#</a></h3> <p>Spectre uses <a href="https://github.com/postcss/autoprefixer" target="_blank">Autoprefixer</a> to make most styles compatible with earlier browsers and <a href="https://necolas.github.io/normalize.css/" target="_blank">Normalize.css</a> for CSS resets. Spectre is designed for modern browsers. For best compatibility, these browsers are recommended:</p> <ul> <li>Chrome <small class="label label-success">LAST 4</small></li> @@ -395,7 +395,7 @@ gulp.task(<span class="hljs-string">'prefix'</span>, <span class="hljs-function" <p>Spectre supports Internet Explorer 10+, but some HTML5 and CSS3 features are not perfectly supported by Internet Explorer.</p> </div> <div class="container" id="whatsnew"> - <h3 class="s-title"><a class="anchor" href="#whatsnew" aria-hidden="true">#</a>What's new</h3> + <h3 class="s-title">What's new<a class="anchor" href="#whatsnew" aria-hidden="true">#</a></h3> <p><strong>September 2017</strong></p> <ul> <li><a href="experimentals.html#off-canvas">Off-canvas</a>: navigation layout that the sidebar can slide in and out of the viewport <small class="label label-primary">NEW</small></li> |