diff --git a/README.md b/README.md index 630698f..36ec1a8 100644 --- a/README.md +++ b/README.md @@ -2,88 +2,85 @@ [![NPM Version](https://img.shields.io/npm/v/@intergrav/dev.css)](https://www.npmjs.com/package/@intergrav/dev.css) [![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hm/@intergrav/dev.css)](https://cdn.jsdelivr.net/npm/@intergrav/dev.css/) [![Discord](https://img.shields.io/discord/1262738186338308126?logo=discord&logoColor=%23fff&color=%235865F2)](https://discord.gg/m5tUgaM3uK) [![GitHub Repo stars](https://img.shields.io/github/stars/intergrav/dev.css)](https://tangled.org/devins.page/dev.css) -dev.css is a tiny, simple, classless CSS framework inspired by [new.css](https://newcss.net). It is designed to make any plain HTML file modern and responsive. The minified stylesheet weighs only **~4.8kb**. It also has some extra features, such as an optional sidebar and addons. +A tiny, classless CSS framework inspired by [new.css](https://newcss.net). Drop it in and any plain HTML file becomes modern and responsive. The minified stylesheet weighs ~4.8kb. -You can find the website at devcss.devins.page, which contains a demo page. +Good for simple blogs, personal sites, link pages, and HTML prototyping. Not meant for very complex web apps or sites, though you can build from it. + +Website and demo:
-Click to view preview +Preview (not completely up-to-date im lazy) dev.css desktop demo, light mode dev.css desktop demo, dark mode dev.css mobile demo, light mode dev.css mobile demo, dark mode
-## Who is this for? - -dev.css is a great choice for: - -- A simple blog -- A simple "about me" website -- Collecting your most used links -- Prototyping your raw HTML - -dev.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. - -If you're using dev.css on your site, feel free to use this "powered by dev.css" badge if you want to promote the project: +If you use dev.css, feel free to add the badge: ```html powered by dev.css ``` -powered by dev.css +powered by dev.css ## Installing -### HTML import - -To use dev.css in your HTML, simply add the following line to the `` section of your HTML file: +### HTML ```html ``` -### `npm`, `pnpm`, etc - -Another 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. +### npm / pnpm / etc ```sh npm add @intergrav/dev.css -# or + pnpm add @intergrav/dev.css ``` -### Importing fonts +You can also load a font from [fontsource.org](https://fontsource.org) if you want a consistent font. By default, system sans-serif and monospace fonts are used. -You can also load a font from [fontsource.org](https://fontsource.org) if you'd like a consistent font. By default, the system/browser sans-serif and monospace fonts will be used, such as Microsoft's Segoe UI or Apple's San Francisco. +## Structure -## Elements and Structure +dev.css uses semantic HTML. Here's the recommended page structure: -dev.css takes advantage of semantic HTML elements. Here are some guidelines on how to use them for the best results. +```html + + + ... + + +
...
+ +
...
+ + + +``` ### Header -It's recommended that you add a header to your page. To add one, place a `
` tag at the top of your ``. You can use an `

` tag as your website's title. You can also add a `

` element as an optional short description of the site. +Place a `

` at the top of ``. Use `

` for the site title, `

` for an optional description, and `

``` @@ -107,18 +103,18 @@ If you'd like, you could instead use [breadcrumb navigation](https://en.wikipedi ### Main -For your main content, or the actual content of the page, it is heavily recommended that you wrap all of it in a `
` tag. Otherwise, certain features from dev.css may not work properly. It may also benefit search engine optimization. Here's an example: +Wrap your page content in `
`. Required for the sidebar layout and recommended for SEO. ```html
-

Page 1

-

Welcome to my website's first page! This is an example.

+

Page Title

+

Content goes here.

``` ### Sidebar -Optionally, 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 `