126 lines
5.4 KiB
HTML
126 lines
5.4 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js" lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Hugo Zen Style Guide</title>
|
|
|
|
<meta name="description" content="">
|
|
<meta name="generator" content="kss-node">
|
|
<meta name="viewport" content="width=device-width">
|
|
|
|
<link rel="stylesheet" href="kss-assets/kss.css">
|
|
<link rel="stylesheet" href="../static/css/styles.css">
|
|
<link rel="stylesheet" href="../static/css/style-guide/chroma-kss-styles.css">
|
|
<link rel="stylesheet" href="../static/css/style-guide/kss-only.css">
|
|
|
|
</head>
|
|
<body id="kss-node" >
|
|
|
|
<div class="kss-sidebar kss-style">
|
|
<header class="kss-header">
|
|
<h1 class="kss-doc-title">Hugo Zen Style Guide</h1>
|
|
</header>
|
|
<nav class="kss-nav">
|
|
<ul class="kss-nav__menu">
|
|
<li class="kss-nav__menu-item">
|
|
<a class="kss-nav__menu-link" href="./">
|
|
<span class="kss-nav__ref">0</span
|
|
><span class="kss-nav__name">Overview</span>
|
|
</a>
|
|
</li>
|
|
<li class="kss-nav__menu-item">
|
|
<a class="kss-nav__menu-link" href="section-sass.html">
|
|
<span class="kss-nav__ref">1</span><span class="kss-nav__name">Colors and Sass</span>
|
|
</a>
|
|
</li>
|
|
<li class="kss-nav__menu-item">
|
|
<a class="kss-nav__menu-link" href="section-base.html">
|
|
<span class="kss-nav__ref">2</span><span class="kss-nav__name">Defaults</span>
|
|
</a>
|
|
</li>
|
|
<li class="kss-nav__menu-item">
|
|
<a class="kss-nav__menu-link" href="section-forms.html">
|
|
<span class="kss-nav__ref">3</span><span class="kss-nav__name">forms</span>
|
|
</a>
|
|
</li>
|
|
<li class="kss-nav__menu-item">
|
|
<a class="kss-nav__menu-link" href="section-layouts.html">
|
|
<span class="kss-nav__ref">4</span><span class="kss-nav__name">Layouts</span>
|
|
</a>
|
|
</li>
|
|
<li class="kss-nav__menu-item">
|
|
<a class="kss-nav__menu-link" href="section-components.html">
|
|
<span class="kss-nav__ref">5</span><span class="kss-nav__name">Components</span>
|
|
</a>
|
|
</li>
|
|
<li class="kss-nav__menu-item">
|
|
<a class="kss-nav__menu-link" href="section-navigation.html">
|
|
<span class="kss-nav__ref">6</span><span class="kss-nav__name">Navigation</span>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<article role="main" class="kss-main">
|
|
<div id="kssref-0" class="kss-section kss-section--depth-0 kss-overview kss-style">
|
|
<h1 id="kss-style-guide">KSS Style Guide</h1>
|
|
<p>This style guide documents the designs of this website which are built with component-based styles and Sass variables, functions and mixins. To ensure it is always up-to-date, this style guide is automatically generated from comments in the Sass files.</p>
|
|
<h2 id="organization">Organization</h2>
|
|
<p>Design components are reusable designs that can be applied using just the CSS class names specified in the component. We categorize our components to make them easy to find.</p>
|
|
<dl>
|
|
<dt><strong>Defaults</strong></dt>
|
|
<dd><code>sass/base</code> — The default “base” components apply to HTML elements. Since all of the rulesets in this class of styles are HTML elements, the styles apply automatically.</dd>
|
|
<dt><strong>Layouts</strong></dt>
|
|
<dd><code>sass/layouts</code> — Layout components position major chunks of the page. They just apply positioning, no other styles.</dd>
|
|
<dt><strong>Components</strong></dt>
|
|
<dd><code>sass/components</code> — Miscellaneous components are grouped together, but feel free to further categorize these.</dd>
|
|
<dt><strong>Navigation</strong></dt>
|
|
<dd><code>sass/navigation</code> — Navigation components are specialized design components that are applied to website navigation.</dd>
|
|
<dt><strong>Forms</strong></dt>
|
|
<dd><code>sass/forms</code> — Form components are specialized design components that are applied to forms or form elements.</dd>
|
|
</dl>
|
|
|
|
<p>In addition to the components, our component library also contains these folders:</p>
|
|
<dl>
|
|
<dt><strong>Colors and Sass</strong></dt>
|
|
<dd><code>sass/init</code> — This Sass documents the colors used throughout the site and various Sass variables, functions and mixins. It also initializes everything we need for all other Sass files: variables, 3rd-party libraries, custom mixins and custom functions.</dd>
|
|
<dt><strong>Style guide helper files</strong></dt>
|
|
<dd><code>sass/style-guide</code> — files needed to build this automated style guide; includes some CSS overrides for the default KSS style guide</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</article>
|
|
|
|
<!-- SCRIPTS -->
|
|
<script src="kss-assets/kss.js"></script>
|
|
<script src="kss-assets/scrollspy.js"></script>
|
|
<script src="kss-assets/prettify.js"></script>
|
|
<script src="kss-assets/kss-fullscreen.js"></script>
|
|
<script src="kss-assets/kss-guides.js"></script>
|
|
<script src="kss-assets/kss-markup.js"></script>
|
|
<script>
|
|
prettyPrint();
|
|
var spy = new ScrollSpy('#kss-node', {
|
|
nav: '.kss-nav__menu-child > li > a',
|
|
className: 'is-in-viewport'
|
|
});
|
|
var kssFullScreen = new KssFullScreen({
|
|
idPrefix: 'kss-fullscreen-',
|
|
bodyClass: 'kss-fullscreen-mode',
|
|
elementClass: 'is-fullscreen'
|
|
});
|
|
var kssGuides = new KssGuides({
|
|
bodyClass: 'kss-guides-mode'
|
|
});
|
|
var kssMarkup = new KssMarkup({
|
|
bodyClass: 'kss-markup-mode',
|
|
detailsClass: 'kss-markup'
|
|
});
|
|
</script>
|
|
|
|
|
|
|
|
|
|
<!-- Automatically built using <a href="https://github.com/kss-node/kss-node">kss-node</a>. -->
|
|
</body>
|
|
</html>
|