mirror of
https://github.com/jenil/chota.git
synced 2023-08-10 21:13:07 +03:00
Basic docs
This commit is contained in:
parent
bf70215eda
commit
27f8ded65e
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
node_modules
|
||||
_site
|
||||
*.lock
|
2
Gemfile
Normal file
2
Gemfile
Normal file
@ -0,0 +1,2 @@
|
||||
source 'https://rubygems.org'
|
||||
gem 'github-pages', group: :jekyll_plugins
|
21
LICENSE
21
LICENSE
@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017 Jenil Gogari
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
28
doc-styles.css
Normal file
28
doc-styles.css
Normal file
@ -0,0 +1,28 @@
|
||||
.hero {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
.logo {
|
||||
flex: 1;
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
.logo svg {
|
||||
width: 100%;
|
||||
max-width: 300px;
|
||||
}
|
||||
|
||||
.logo h3 {
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
footer {
|
||||
background-color: #fafafa;
|
||||
padding: 4rem;
|
||||
}
|
||||
|
||||
section {
|
||||
max-width: 700px;
|
||||
margin: 5rem auto;
|
||||
}
|
55
index.html
Normal file
55
index.html
Normal file
@ -0,0 +1,55 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
|
||||
<title>chota.css - A really small CSS framework</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link rel="stylesheet" href="https://unpkg.com/chota">
|
||||
<link rel="stylesheet" href="./doc-styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class="container">
|
||||
<div class="hero is-full-screen">
|
||||
<div class="logo is-center is-vertical-align">
|
||||
<img src="./logo.svg" alt="">
|
||||
<h3>A <strong>small</strong> (3kb) CSS framework.</h3>
|
||||
</div>
|
||||
<div class="row is-center">
|
||||
<div class="col-3">
|
||||
<nav class="tabs">
|
||||
<a href="#features">features</a>
|
||||
<a href="#start">start</a>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<section id="features">
|
||||
<h2>Features</h2>
|
||||
<ul>
|
||||
<li>⚡️ Super light-weight. Just 3kb (minified + gzipped).</li>
|
||||
<li>⛔️ No preprocessor, just plug-n-play</li>
|
||||
<li>📐 Magical 12 column grid</li>
|
||||
<li>🌈 Easy to extended with CSS variables</li>
|
||||
<li>🎲 Comes with a handful of components & utilities</li>
|
||||
<li>✅ Good Semantics</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="start">
|
||||
<h2>Getting Started</h2>
|
||||
<p>All you need is 1 CSS file, <code>chota.css</code> to be included in your webpage.</p>
|
||||
<h5>Easiest way</h5>
|
||||
<p>Link this CSS in your HTML:</p>
|
||||
<pre>https://unpkg.com/chota</pre>
|
||||
<p>You can download it from Github or install it from npm or yarn:</p>
|
||||
<pre>npm install chota</pre>
|
||||
</section>
|
||||
</div>
|
||||
<footer class="is-text-center">
|
||||
<h5>Made by <a href="#">Jenil Gogari</a></h5>
|
||||
</footer>
|
||||
</body>
|
||||
|
||||
</html>
|
Loading…
Reference in New Issue
Block a user