Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #83

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update README.md #83

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c3fc3e
Update README.md
nehemieyac Sep 9, 2022
ba5a16d
Update README.md
nehemieyac Sep 9, 2022
6d9b033
Update README.md
nehemieyac Sep 9, 2022
8b9df24
Update README.md
nehemieyac Sep 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,25 @@ All it does is set some sensible defaults and styles your HTML to look reasonabl
- Collecting your most used links
- Making a simple "about me" site
- Rendering markdown-generated HTML
- Creating a quick simple website

**Demo: [newcss.net](https://newcss.net/?ref=github_demo)**

new.css is also a great source for novice web developers.

The simplicity of new.css allows it to be a hands-on and easy-to-understand learning resource for beginners learning CSS and HTML

---

## Table of Contents

- Usage
- Features
- Themes
- Theme Library
- Customizing Themes
- Contributing
- FAQ
- Made with new.css
- Sponsors
- Support

Expand Down Expand Up @@ -55,17 +61,33 @@ npm i @exampledev/new.css
```shell
yarn add @exampledev/new.css
```
## Features

new.css allows users to make modern web pages using basic HTML that include styling for the following features:
- Headers
- Blockquotes
- Tables
- Short Inline code
- Code Blocks
- Keyboard Text
- Toggle-able drop-down text

## Themes

new.css uses a color palette that can be easily customized. These are declared as a CSS variable in the :root attribute.

### Theme Library

Pre-made themes include:
- Night Theme
- Terminal Theme

See pre-made themes at [newcss.net/themes](https://newcss.net/themes/).

### Customizing Themes

Users can create their own themes and customize them to their liking.

Information is available [on the wiki](https://github.com/xz/new.css/wiki/Customizing-Themes).

## FAQ
Expand All @@ -80,6 +102,16 @@ new.css was designed to work with nothing but raw HTML, but some awesome communi

Check if your platform or service supports custom CSS. If it does, it'll probably work. You're welcome to [ask the community](https://discord.gg/hhuuC4w) as well.

**Will this make my website mobile-friendly?**

Yes, using new.css as a framework for your website will allow it to be mobile-friendly.

All themes, including customized ones, are mobile-friendly.

## Contributing
Interested in improving and building new.css?
Click [here](https://github.com/xz/new.css/blob/master/CONTRIBUTING.md) to view contributing guidelines.

## Sponsors
- <a href="https://domaincord.org/?utm_source=xz&utm_campaign=new.css">Domaincord</a> (also a domain name discussion group <a href="https://discord.gg/239EP7G">here</a>!)
- <a href="https://vercel.com/?utm_source=xz&utm_campaign=new.css">Vercel</a>
Expand Down