diff --git a/.github/examples.jpg b/.github/examples.jpg deleted file mode 100644 index 240c0349..00000000 Binary files a/.github/examples.jpg and /dev/null differ diff --git a/.github/logo.svg b/.github/logo.svg deleted file mode 100644 index 6d1d4b1f..00000000 --- a/.github/logo.svg +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - - - - \ No newline at end of file diff --git a/README.md b/README.md index 52cca090..78772a8a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,16 @@

- - + +

+ +

+ Minimal CSS Framework for Semantic HTML +

+

- A minimalist and lightweight starter kit that prioritizes semantic syntax, making every HTML element responsive and elegant by default. + A minimalist and lightweight starter kit that prioritizes semantic syntax, making every HTML element responsive and elegant by default.

@@ -13,30 +18,20 @@

- Documentation + Documentation

-# Pico.css +## A Superpowered HTML Reset +With just the right amount of everything, Pico is great starting point for a clean and lightweight design system. -**Class-light and Semantic** -Thriving on simplicity, Pico directly styles your HTML tags, using fewer than 10 `.classes`` overall. It also comes with a class-less version for wild HTML purists. +- Class-light and Semantic +- Great Styles with Just CSS +- Responsive Everything +- Light or Dark Mode +- Easy Customization +- Optimized Performance -**Great Styles with Just CSS** -No extra baggage needed. Pico works seamlessly without dependencies, package managers, external files, or JavaScript, achieving elegant and straightforward styles with pure HTML markup. - -**Responsive Everything** -Effortless elegance on every device. Pico natively scales font sizes and spacings with screen widths, resulting in a consistent and elegant look across devices. No extra classes or configuration needed. - -**Light or Dark Mode** -Pico comes with two accessible, neutral color schemes out of the box: light and dark. The best part? It automatically adapts to users' `prefers-color-scheme``, all without the use of JavaScript. - -**Easy Customization** -Customize Pico with over 130 CSS variables, or dive deeper by using SASS. Switch between 20 handcrafted color themes and compose with 30+ modular components to tailor the UI to your brand's look and feel. - -**Optimized Performance** -Speed meets elegance. Unlike bulky and overcomplicated frameworks that demand extensive class overrides and JavaScript, Pico keeps your HTML lean, decreases memory usage by avoiding excessive CSS specificity, and reduces loaded files. - -# Table of contents +## Table of contents - [Quick start](#quick-start) - [Class-less version](#class-less-version) @@ -46,54 +41,82 @@ Speed meets elegance. Unlike bulky and overcomplicated frameworks that demand ex - [Contributing](#contributing) - [Copyright and license](#copyright-and-license) -# Quick start +## Quick start There are 4 ways to get started with pico.css: -**Install manually** +### Install manually -[Download Pico](https://github.com/picocss/pico/archive/refs/heads/v2.zip) and link `/css/pico.min.css` in the `` of your website. +[Download Pico](https://github.com/picocss/pico/archive/refs/heads/main.zip) and link `/css/pico.min.css` in the `` of your website. ```html ``` -**Usage from CDN** +### Usage from CDN Alternatively, you can use [jsDelivr CDN](https://www.jsdelivr.com/package/npm/@picocss/pico) to link pico.css. ```html - + ``` -**Install with NPM** +### Install with NPM ```shell -npm install @picocss/pico@next +npm install @picocss/pico ``` +Or + ```shell -yarn add @picocss/pico@next +yarn add @picocss/pico ``` -**Install with Composer** +Then, import Pico into your SCSS file with [@use](https://sass-lang.com/documentation/at-rules/use): + +```SCSS +@use "pico"; +``` + +### Install with Composer ```shell composer require picocss/pico ``` -# Class-less version +### Starter HTML template -Pico provides a `.classless` version ([example](https://picocss.com/examples/classless)). +```HTML + + + + + + + + Hello world! + + +
+

Hello world!

+
+ + +``` -In this version, `header`, `main` and `footer` act as containers. +## Class-less version + +Pico provides a `.classless` version ([example](https://picocss.com/examples)). + +In this version, `
`, `
`, and `