-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
better minify, gitgnore, readme docs
- Loading branch information
Showing
6 changed files
with
54 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
utils/ | ||
zephyr.css | ||
zephyr.js | ||
package.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,49 @@ | ||
# Zephyr | ||
A totally different CSS framework striving to achieve elegance and efficiency by using custom HTML tags with predefined CSS and JS instead of classes. It is highly customizable, allowing for CSS properties to be used as HTML attributes. Has dark-mode built in. Heavily in development. | ||
|
||
https://dxxxxy.github.io/Zephyr/ | ||
https://dxxxxy.github.io/Zephyr/ | ||
|
||
## Usage | ||
Use HTML as you normally would. To use the custom tags, prefix your tags by `z`. | ||
<hr> | ||
|
||
Here's an example of a custom `<a>` tag: | ||
|
||
```html | ||
<za href="https://somewhere.com">Example</za> | ||
``` | ||
|
||
You can also use `CSS` rules in `HTML` attributes: | ||
|
||
```html | ||
<zbody font-family="Euclid Circular B Bold"></zbody> | ||
``` | ||
|
||
You can customize the preset colors by using the <zconfig> tag: | ||
|
||
```html | ||
<!-- if information is omitted, it will be set to default --> | ||
<zconfig $darkColor="#4a94fa"></zconfig> | ||
|
||
<!-- these are the variable names and their defaults --> | ||
$darkcolor = "#4a94fa" | ||
$lightcolor = "#990099" | ||
$darkbgcolor = "#000000" | ||
$lightbgcolor = "#ffffff" | ||
``` | ||
|
||
Lastly, there are many built-in tags ready to be used at any time: | ||
|
||
```html | ||
<!-- this will generate a loader that will wait until the whole window loads and | ||
will wait 2000ms after doing so before disapearing and letting everything appear --> | ||
<zloader waitFor="windowLoad" delay="2000"></zloader> | ||
|
||
<!-- this will create a dark mode button with a pointer cursor. clicking on it | ||
will switch between the theme colors previously defined in <zconfig> --> | ||
<zdark cursor="pointer"></zdark> | ||
``` | ||
|
||
There is currently a limited number of tags and the design itself has not reached its prime. | ||
|
||
You can check out https://dxxxxy.github.io/Zephyr/ or the `index.html` file included in the project as a reference. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"scripts": { | ||
"min": "css-minify -f zephyr.css -o /" | ||
"min": "minify zephyr.css > zephyr.min.css && minify zephyr.js > zephyr.min.js" | ||
} | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.