lightweight, simple, classless CSS framework inspired by new.css
devcss.devins.page
framework
lightweight
css
classless
stylesheet
1# intergrav/dev.css
2
3[](https://www.npmjs.com/package/@intergrav/dev.css) [](https://cdn.jsdelivr.net/npm/@intergrav/dev.css/) [](https://discord.gg/m5tUgaM3uK) [](https://github.com/intergrav/dev.css)
4
5dev.css is a tiny, simple, classless CSS framework inspired by Vercel's [Geist](https://vercel.com/geist) design system. It is designed to make any plain HTML file look clean and modern. The minified stylesheet weighs only **~5.5kb** and includes both light and dark themes.
6
7You can find the website at <a href="https://devcss.devins.page">devcss.devins.page</a>, which contains a demo page.
8
9<details>
10<summary>Click to view preview</summary>
11<img src=".github/static/preview-desktop-light.png" alt="dev.css desktop demo, light mode">
12<img src=".github/static/preview-desktop-dark.png" alt="dev.css desktop demo, dark mode">
13<img height="748px" src=".github/static/preview-mobile-light.png" alt="dev.css mobile demo, light mode">
14<img height="748px" src=".github/static/preview-mobile-dark.png" alt="dev.css mobile demo, dark mode">
15</details>
16
17## Who is this for?
18
19dev.css is a great choice for:
20
21- A simple blog
22- A simple "about me" website
23- Collecting your most used links
24- Prototyping your raw HTML
25
26dev.css was not meant for very complex websites. Although, if you need something more complex, you could build from/modify this stylesheet for your website. An example of a site that uses dev.css is [SkywardMC's wiki](https://skywardmc.org).
27
28## Installing
29
30### HTML import
31
32To use dev.css in your HTML, simply add the following line to the `<head>` section of your HTML file:
33
34```html
35<link
36 rel="stylesheet"
37 href="https://cdn.jsdelivr.net/npm/@intergrav/dev.css@4"
38/>
39```
40
41### `npm`, `pnpm`, etc
42
43Another way to install dev.css is to add the npm package to your project through your preferred package manager. This command adds the latest version to your project.
44
45```sh
46npm add @intergrav/dev.css
47# or
48pnpm add @intergrav/dev.css
49```
50
51### Importing fonts
52
53You can also load a font from [intergrav/fonts](https://github.com/intergrav/fonts#readme) (or anywhere else) if you'd like a consistent font. Geist and Inter fonts work with dev.css out of the box, other fonts will require a theme to be used. If these fonts are not available, the default system/browser sans-serif and monospace fonts will be used, such as Microsoft's Segoe UI or Apple's San Francisco.
54
55## Elements and Structure
56
57dev.css takes advantage of semantic HTML elements. Here are some guidelines on how to use them for the best results.
58
59### Header
60
61It's recommended that you add a header to your page. To add one, place a `<header>` tag at the top of your `<body>`. You can use an `<h1>` tag as your website's title. You can also add a `<p>` element as an optional short description of the site.
62
63If you want to add a traditional navigation element, you should lay out your `<nav>` element like this:
64
65```html
66<header>
67 <h1>Website Title</h1>
68 <p>An optional description of the website.</p>
69 <nav>
70 <ul>
71 <li><a href="https://example.com">Demo</a></li>
72 <li><a href="https://example.com">GitHub</a></li>
73 <li><a href="https://example.com">npm</a></li>
74 <li><a href="https://example.com">jsDelivr</a></li>
75 </ul>
76 </nav>
77</header>
78```
79
80
81
82If you'd like, you could instead use [breadcrumb navigation](https://en.wikipedia.org/wiki/Breadcrumb_navigation). If you're using the header-oneline addon while doing this, it's recommended to remove all other elements in the header and move `<h1>` to `<main>`.
83
84```html
85<header>
86 <nav>
87 <a href="../..">dev.css</a> / <a href="..">Blog</a> / Making a Website
88 </nav>
89 <h1>Making a Website</h1>
90 <p>Making a basic website with dev.css.</p>
91</header>
92```
93
94
95
96### Main
97
98For your main content, or the actual content of the page, it is heavily recommended that you wrap all of it in a `<main>` tag. Otherwise, certain features from dev.css may not work properly. It may also benefit search engine optimization. Here's an example:
99
100```html
101<main>
102 <h1>Page 1</h1>
103 <p>Welcome to my website's first page! This is an example.</p>
104</main>
105```
106
107### Sidebar
108
109Optionally, you can add a sidebar to your page for pretty much anything you'd like. A good usage for this could be, for example, complex navigation on a docs website, where you wouldn't be able to fit it all into the header. The sidebar will sort normally with the rest of the content on smaller screens. To make a sidebar, place an `<aside>` tag, and then put an `<article>` inside. You must put it above the `<main>` content. You can have up to two sidebars per page - the second one will appear on the right side. Here's an example:
110
111```html
112<aside>
113 <article>
114 <h1>Sidebar</h1>
115 <nav>
116 <ul>
117 <li><a href="https://example.com">Page 1</a></li>
118 <li>
119 <a href="https://example.com">Page 2</a>
120 <ul>
121 <li><a href="https://example.com">Page 2.1</a></li>
122 <li><a href="https://example.com">Page 2.2</a></li>
123 </ul>
124 </li>
125 <li><a href="https://example.com">Page 3</a></li>
126 <li><a href="https://example.com">Page 4</a></li>
127 </ul>
128 </nav>
129 </article>
130</aside>
131```
132
133### Footer
134
135Optionally, you can add a footer to your page. This could include copyright information, what the website was built with, it's source link, anything really. To make a footer, place a `<footer>` tag at the bottom of your `<body>`. It also formats the nav element in the same way that the header does.
136
137### Final Structure
138
139In the end, this is what your page structure should look like if you decide to add everything:
140
141```html
142<html>
143 <head>
144 ...
145 </head>
146 <body>
147 <header>...</header>
148 <aside>...</aside>
149 <main>...</main>
150 <footer>...</footer>
151 </body>
152</html>
153```
154
155### Text
156
157Wrap all body text in `<p>` tags, unless it's the sole child of another element. Use the `<blockquote>` tag for quotes. To highlight text, wrap it in the `<mark>` tag. For code, use `<code>` for short inline code snippets and wrap that with `<pre>` for code blocks. Use `<kbd>` for keyboard input.
158
159### Button
160
161To create a link button, wrap the button in an `<a>` tag. Here's an example:
162
163```html
164<a href="https://example.com">
165 <button>Click me!</button>
166</a>
167```
168
169### Details
170
171The `<details>` element can be used to create a toggle-able dropdown without using any JavaScript. Here's an example:
172
173```html
174<details>
175 <summary>Click me!</summary>
176 <p>Lorem ipsum dolor sit amet.</p>
177</details>
178```
179
180### More
181
182To learn about other HTML elements and how to write HTML, visit [W3Schools/html](https://www.w3schools.com/html/).
183
184## Addons
185
186dev.css provides a basic set of styles. Addons are small CSS or JS snippets that can be used to adjust or add functionality to dev.css based on your needs. Here are the built-in addons.
187
188### `header-oneline.css`
189
190This addon makes the header much more compact on narrow viewports. To use, add the following line after the `dev.css` import:
191
192```html
193<link
194 rel="stylesheet"
195 href="https://cdn.jsdelivr.net/npm/@intergrav/dev.css@4/addon/header-oneline.min.css"
196/>
197```
198
199### `header-sticky.css`
200
201This addon makes the header sticky, always staying at the top of the screen. Note that this addon is recommended for small headers, as it may affect the usability of your site if the header is large and takes up a lot of space. If using with `header-oneline.css`, place this after. To use, add the following line after the `dev.css` import:
202
203```html
204<link
205 rel="stylesheet"
206 href="https://cdn.jsdelivr.net/npm/@intergrav/dev.css@4/addon/header-sticky.min.css"
207/>
208```
209
210### `scroll-to-top.js`
211
212This addon creates a small "scroll to top" button in the bottom right corner of your website when the user scrolls down. The button uses the default dev.css button style. The button is slightly opaque so that you can see it but it doesn't block the view. To use this addon, add the following line after the `dev.css` import:
213
214```html
215<script
216 src="https://cdn.jsdelivr.net/npm/@intergrav/dev.css@4/addon/scroll-to-top.min.js"
217 defer
218></script>
219```
220
221## Themes
222
223dev.css supports custom colors and fonts through themes. You can find some pre-made themes in the `/theme` folder. To use a theme, simply apply it after the dev.css stylesheet. There are night and day themes, a set of Catppuccin themes, and a terminal theme. For example, to apply the terminal theme, add the following line after the `dev.css` import:
224
225```html
226<link
227 rel="stylesheet"
228 href="https://cdn.jsdelivr.net/npm/@intergrav/dev.css@4/theme/terminal.user.min.css"
229/>
230```
231
232If you are creating your own theme, see the `boilerplate.user.css` file.
233
234### Userstyles
235
236The built-in themes can also be installed to your userstyle manager, such as Stylus. That theme will override any website using dev.css. To install one, open the theme's file in your browser.
237
238## Credits
239
240- [xz/new.css](https://github.com/xz/new.css) being a major inspiration for this project
241- Vercel's [Geist](https://vercel.com/geist/introduction) design system
242- [Catppuccin](https://github.com/catppuccin) for the colors used in the Catppuccin themes