This repository was archived by the owner on Aug 30, 2020. It is now read-only.
forked from Kimeiga/bahunya
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathusage.html
More file actions
114 lines (103 loc) · 5.18 KB
/
usage.html
File metadata and controls
114 lines (103 loc) · 5.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="keywords" content="css, html5, css framework" />
<meta name="description" content="10KB Classless CSS Framework" />
<link rel="stylesheet" href="style.css" />
<title>Bahunya - Usage</title>
<meta property="og:title" content="Bahunya" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://kimeiga.github.io/bahunya/" />
<meta property="og:image:secure_url" content="https://image.ibb.co/kAXSpz/bahunya_logo.png" />
<meta property="og:description" content="10KB Classless CSS Framework" />
<link rel="icon" type="image/png" href="./bahunya-logo.png" />
</head>
<body>
<header>
<nav>
<h1><a href="./">BAHUNYA</a></h1>
<input type="checkbox" id="menu-toggle">
<label for="menu-toggle">☰</label>
<a href="./installation.html">INSTALLATION</a>
<a href="./usage.html">USAGE</a>
<a href="./customization.html">CUSTOMIZATION</a>
<a href="https://github.com/Kimeiga/bahunya" target="_blank">GITHUB</a>
</nav>
<h1>Bahunya Usage</h1>
</header>
<main>
<article>
<p>In order to utilize Bahunya correctly, you have to write semantically correct HTML (that's it :) ). However, Bahunya made certain decisions about correct HTML that you will have to know to use it.</p>
<h2>Listless Navigation</h2>
<p>You'll notice that Bahunya's navbar only works with a listless navigation (one without <code>ul</code> and <code>li</code>
elements). This is because people with screen readers find it <a href="https://css-tricks.com/navigation-in-lists-to-be-or-not-to-be/"
target="_blank">easier to navigate listless navigation</a> as the screen reader peruses it quicker than a listful
(?) navigation.</p>
<p>Your markup should look like the following. An <code><h1></code> containing an anchor tag for the site
title, and then the anchor tags for the links and the hamburger menu. </p>
<pre><code class="language-markup"><body>
<header>
<nav>
<h1><a href="#">BAHUNYA</a></h1>
<input type="checkbox" id="menu-toggle">
<label for="menu-toggle">&#9776;</label>
<a href="#">STARTUP</a>
<a href="#">MINIMAL</a>
<a href="#">BOLD</a>
<a href="https://github.com/Kimeiga/bahunya" target="_blank">GITHUB</a>
</nav></code></pre>
<h2>HTML Structure</h2>
<p>Bahunya uses the following HTML semantic hierarchy.</p>
<pre><code class="lang-markup"><!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="https://cdn.rawgit.com/kimeiga/bahunya/css/bahunya-0.1.1.css"/>
</head>
<body>
<header>
<nav>
<h1><a href="/">SITE_TITLE</a></h1>
			<a href="/page-1.html">PAGE-1</a>
</nav>
<h1>SITE-TITLE</h1>
</header>
<main>
<article>
			<h2>Stuff</h2>
			
			<section>
				<h3>Section of stuff</h3>
			</section>
			
</article>
</main>
<footer>
<p>Copyright</p>
<nav>
<a href="/somewhere">Somewhere</a>
<a href="/somewhere-else">Somewhere else</a>
</nav>
</footer>
</body>
</html></code></pre>
<p>Bahunya is following the <a href="https://www.semrush.com/blog/semantic-html5-guide/">Semrush Semantic HTML5 guide</a>.</p>
<p>As you can see, there's a <code><header></code>, <code><main></code>, and <code><footer></code>. Inside the header, there's a <code><nav></code> that is rendered to a navbar, and the rest is an actual header of the page.</p>
<p>The <code><main></code> contains the body of the content. The <code><article></code> tag is good semantics, so I recommend using it. It just makes the width of the main body smaller. If you want sub-sections of the content, use <code><section></code> tags.</p>
</article>
</main>
<footer>
<p>
Created by <a href="http://www.kimei.ga">Hakan Alpay</a>, 2018
</p>
<p>Inspired by <a href="https://yegor256.github.io/tacit/">Tacit</a>, a classless CSS framework</p>
<nav>
<a href="https://github.com/kimeiga/bahunya">GitHub Repo</a>
<a href="https://opensource.org/licenses/MIT">MIT license</a>
<a href="https://github.com/Kimeiga/bahunya/blob/css/bahunya-0.1.1.css">Download CSS</a>
</nav>
</footer>
<script src="prism.js"></script>
</body>
</html>