forked from codazoda/neatcss
-
Notifications
You must be signed in to change notification settings - Fork 0
/
neat.html
188 lines (106 loc) · 7.89 KB
/
neat.html
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!DOCTYPE html>
<head>
<title>Neat CSS</title>
<link rel="stylesheet" type="text/css" href="neat.css">
<link rel="stylesheet" type="text/css" href="custom.css">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<a class="home" href="neat.html">↖</a>
<h1>Neat CSS</h1>
<p>Rapidly build efficient sites with <em>Neat</em>, the minimalist css framework.</p>
<ol>
<li><a href="#download">Download</a></li>
<li><a href="#about">About</a></li>
<li><a href="#start">Getting Started</a></li>
<li><a href="#uses">Uses</a></li>
<li><a href="#customizing">Customizing</a></li>
<li><a href="#decisions">Design Decisions</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#github">GitHub</a></li>
</ol>
<h2 id="download">Download</h2>
<p><a href="https://github.com/codazoda/neatcss/archive/v0.1.0.zip">Neat CSS 0.1.0</a> — 26 September 2022</p>
<h2 id="about">About</h2>
<img src="https://neat.joeldare.com/images/neat-screenshot.png" class="bordered">
<p>Neat is a simple HTML template. It's tiny, opinionated, and made to last. It's created by Joel Dare and heavily inspired by other minimalist sites like <a href="https://100r.co">Hundred Rabbits</a> and dozens of similar blogs.</p>
<p>Neat is about 2Kb and that is not minified or compressed. This documentation adds a few more bytes.</p>
<p>"That's pretty neat!"</p>
<h2 id="start">Getting Started</h2>
<p>Grab the <em>neat.css</em> and <em>neat.html</em> files.</p>
<pre><code>curl -O https://neat.joeldare.com/neat.css
curl -O https://neat.joeldare.com/neat.html</code></pre>
<p>Then copy <em>neat.html</em> to <em>index.html</em> and make your changes. Use <em>neat.html</em> as a reference.</p>
<h2 id="uses">Uses</h2>
<p><em>Neat</em> was designed for.</p>
<ul>
<li>Blogs</li>
<li>Journals</li>
<li>Technical sites</li>
<li>Documentation</li>
<li>Books</li>
<li>Simple shops</li>
</ul>
<h2 id="customizing">Customizing</h2>
<p>It's easy to customize Neat. The best way is to create a new <em>custom.css</em> file and then add the following line to the head of your page.</p>
<pre><link rel="stylesheet" type="text/css" href="custom.css"></pre>
<p>That will give you the option of updating <em>neat.css</em> without losing any of your personalizations.</p>
<h2 id="decisions">Design Decisions</h2>
<p>Neat is opinionated and here are some of the design decisions and the rationale for each of them.</p>
<h3>Small</h3>
<p>In contrast with the majority of the modern web, Neat was designed to be tiny. A side-effect of being small is that it's also very fast.</p>
<h3>Low Energy</h3>
<p>Because it's small and fast it also consumes fewer resources. It should work well even on the slowest connections. Consuming less energy on both the client and the server.</p>
<h3>Long-Lasting</h3>
<p>The web is relatively young and technology changes fast but one of the technologies that has lasted as long as the Internet is HTML. There are lots of other interesting formats but plain HTML has a good chance of working well into the future.</p>
<h3>Not Minified</h3>
<p>Minified code requires the complexity of a transpiler and makes the site less open for inspection, learning, accessibility, and archive. The size trade-off isn't worth it for Neat.</p>
<h3>Max Width</h3>
<p>The body <em>max-width</em> is 800px by default. <a href="https://cdn.tc-library.org/Edlab/eye-tracking%20article.pdf">Research</a> has shown that limiting the width can lead to better retention of the content itself, as well as a decrease in eye strain. A thinner column of text is more readable on very large monitors. This is simple to change by editing the <em>max-width</em> of the <em>body</em> element in your <em>custom.css</em> file.</p>
<h3>Centered Body</h3>
<p>The body is centered as of <em>Neat 0.1.0</em>. I use <em>Neat</em> as a starting point for most of my own projects and I found myself centering the body the majority of the time. As a result, the default is now centered. You can still left-align by adding <code>margin-left</code> and <code>margin-right</code> to your <em>custom.css</em> file.</p>
<h3>Images</h3>
<p>Images are 100% width by default. This works best with images that are wide and short. You can set manual sizes on individual images as it suits you or change the image width in your <em>custom.css</em> if you typically use a different aspect ratio.</p>
<p>Images have no border by default. This works well for dark colored images but light colored images can get lost. Add something like <code>border: 3px solid #404040</code> if your image needs a border.</p>
<h3>Left Gutter</h3>
<p>The left gutter is wider at larger sizes, giving the page a little more breathing room at desktop and tablet sizes.</p>
<h3>Buttons</h3>
<p>There are multiple types of buttons. There are anchor tags (links) that should sometimes look like buttons, <em>button</em> tags, and <em>submit</em> style <em>input</em> tags.</p>
<p>It's best to use semantic web tags whenever possible. Buttons can be a unique case where you're often linking somewhere, but the button tag doesn't support the href attribute. So, buttons can be <em>anchor</em> tags with a <em>class</em> of <em>button</em>.</p>
<p>The html <em>button</em> tag is also styled in the same way. When buttons aren't links, for example when you're using JavaScript to trigger actions from button clicks, the button tag still works.</p>
<p><em>Input</em> tags of type <em>submit</em> are also styled this way.</p>
<pre><a href="#" class="button"></pre>
<pre><button>Button</button></pre>
<pre><input type="submit" value="Button"></pre>
<button class="center">Button</button>
<h3>Input Fields</h3>
<p>The <em>input</em> tag is styled to support light and dark themes.</p>
<pre><input></pre>
<input class="center" value="My input here">
<h3>No Header</h3>
<p>Because of the complexity of the css and the distraction of navigation, there is no header and no navigation, other than the link back to the home page.</p>
<h3>Responsive</h3>
<p>Neat is designed to be responsive.</p>
<h3>Grid</h3>
<p>As of v0.1.0 Neat has a simple grid system. Each column is automatically sized. Put in four columns and you'll get four equally sized columns. All columns collapse to a single column on mobile.</p>
<pre><code><div class="row">
<div class="column">One</div>
<div class="column">Two</div>
<div class="column">Three</div>
<div class="column">Four</div>
</div></code></pre>
<div class="row">
<div class="column">One</div>
<div class="column">Two</div>
<div class="column">Three</div>
<div class="column">Four</div>
</div>
<h3>Centering</h3>
<p>You can throw the <em>center</em> class on almost anything you want to center, including a <em>div</em> tag.
<h2 id="contributing">Contributing</h2>
<p>Neat is distributed as open-source under the MIT license.</p>
<p>Anything related to <em>Neat</em> is fair game for discussion. Anyone who's interested is welcome to join in the conversation. If you find a problem or have a suggestion, feel free to <a href="https://github.com/codazoda/neatcss/issues">create an issue</a> on GitHub. I'm also happy to review code change requests. To do that, fork the project and create a pull request or just <a href="mailto:[email protected]">email me</a> a diff. Feedback and discussions will lead to better ideas for future improvements.</p>
<h2 id="github">GitHub</h2>
<p>You'll find <a href="https://github.com/codazoda/neatcss">Neat CSS on GitHub</a>.</p>
</body>
</html>