NES.css is a NES-style(8bit-like) CSS Framework.
Installation
Styles
NES.css is available via either npm (preferred), Yarn, or a CDN.
via package manager
npm install nes.css
# or
yarn add nes.css
Our package.json
contains some additional metadata under the following keys:
sass
- path to our main Sass source filestyle
- path to our non-minified CSS
AltCSS(sass, scss...)
// style.scss
@import "./node_modules/nes.css/css/nes.css"
JavaScript
// script.js
import "nes.css/css/nes.min.css";
You need to install css-loader.
HTML
<!-- index.html -->
<html>
<head>
<link rel="stylesheet" href="./node_modules/nes.css/css/nes.min.css">
</head>
<body></body>
</html>
via CDN
Import the CSS via a <link />
element:
<!-- minify -->
<link href="https://unpkg.com/[email protected]/css/nes.min.css" rel="stylesheet" />
<!-- latest -->
<link href="https://unpkg.com/[email protected]/css/nes.min.css" rel="stylesheet" />
<!-- core style only -->
<link href="https://unpkg.com/nes.css/css/nes-core.min.css" rel="stylesheet" />
Fonts
NES.css doesn't provide any fonts, but we do maintain the following list of fonts that we recommend for usage alongside the library.
Language | Font |
---|---|
(Default) | Press Start 2P |
English | Kongtext |
Japanese | 美咲フォント |
Japanese | Nu もち |
Korean | 둥근모꼴 |
Chinese | Zpix (最像素) |
Usage
NES.css only provides components. You will need to define your own layout.
The recommended font for NES.css is Press Start 2P. However, Press Start 2P only supports English characters. When you're using this framework with any language other than English, please use another font. Follow the Google Fonts instructions about how to include them, or simply include it as below:
<head>
<link href="https://fonts.googleapis.com/css?family=Press+Start+2P" rel="stylesheet">
<link href="https://unpkg.com/nes.css/css/nes.css" rel="stylesheet" />
<style>
html, body, pre, code, kbd, samp {
font-family: "font-family you want to use";
}
</style>
</head>
CSS Only
NES.css only requires CSS and doesn't depend on any JavaScript.
Browser Support
NES.css is compatible with the newest version of the following browsers:
- Chrome
- Firefox
- Safari
Untested
- IE/Edge
Copyright and license
Code and documentation copyright 2018 B.C.Rikko. Code released under the MIT License. Docs released under Creative Commons.
Development
If you'd like to help us out with the project, we welcome contributions of all types! Check out our CONTRIBUTING.md
for more details on how you can help make NES.css amazing!
🐁 add cursor
Hey! I wanted to solve this issue: https://github.com/BcRikko/NES.css/issues/2.
I saw how you did the icons with the
pixelize
mixin, however, as far as I know, the cursor property can only receive an URL. So I added theimages
folder andcursor-url
variable which holds the url for thecursor.png
. MDN Docs Reference for cursor.Also, I wasn't very sure how to test this, I don't know how to build the project. I wanted either a
.css
file or a URL to import it. So I couldn't test this branch :slightly_frowning_face: .Can you help me to do this? I am not that good in CSS at all hahha.
More icons
Is there any way we can get more social-media icons? Like Gmail, Youtube, and phone number? :heart: Or how can i make it?
Buttons color Error
The color of the buttons stays the same when you click it then you need to click other place to restore the original button color. It's a little hard to explain.
Hello.
I would like to see a
<select>
component in the framework.I made this but I'm not very confident about the desing. What do you think? Should I make a pull request?
Thanks.
Troublesome commitlint
Since we've added commitlint, I've discussed it being removed.
Here's what I tried to just do a very basic thing:
Every time once of these got me an error, I tried to modify my commit messages based on the error only to get other errors.
I was done, and I wanted to use
--no-verify
to just skip this linting for commit message, but still, I get an error.Do we REALLY need this? I see this as anti-productive instead of the other way around.
[#137] Update docs
This updates the
README.md
to be much more comprehensive, and moves the contributing information intoCONTRIBUTING.md
. It also adds the Code of Conduct as requested in #137.It would be awesome if I could also get some of our contributors to hook me up with updated translations.
| Language | README | CONTRIBUTING | CODE OF CONDUCT | Contributors | |------------|--------|--------------|-----------------|----------------| | English | ✓ | ✓ | ✓ | @trezy | | Japanese | ✓ | ✓ | ✓ | @BcRikko | | Portuguese | ✓ | ✓ | ✓ | @guastallaigor | | Spanish | ✓ | ✓ | ✓ | @4k1k0 |
feat(breaking): remove google font import
Closes #34
Summary
Removes google font import from the framework. Adds google font import to the example site. Updates readme.
TODO
I don't speak Japanese, so if you do want to include this, can you update the Japanese section? 😇
Add prefix to class name
⚠️Breaking changes⚠️
Since NES.css doesn't provide layout. It maybe conflict when NES.css using the common class name. Maybe add a prefix like ns- or nes- to solve this.
レイアウト関連のスタイルは提供していないためユーザ任せになる。そのときにNES.cssで汎用的なクラス名を使っているとコンフリクトする可能性がある。
ns-
、nes-
みたいなprefixをつけてコンフリクトを解消したい 🤔Bug: Borders is not responsive anymore
Describe the bug The borders has a few bugs in some resolutions. It's hard to explain but is easy to show, see Screenshots below:
To Reproduce
develop
branch;index.html
file to<link href="./css/nes.min.css" rel="stylesheet" />
;npm run build
;php -S localhost:4167
;Expected behavior Nothing happened with the borders by changing the resolution/zoom.
Screenshots
Environment:
Suggestion(s) for fixing this issue I've no ideia how to fix it. Only solution I see is reverting the borders back for now before the next release.
Additional context In master this is not happening.
Issue and Pull Request templates
Description
This pull request introduces template files which can be used to template future issues and PRs. They may allow a user to structure their post and allows for issues and PRs to be more streamline, especially useful during a mass-processing of many of such tickets!
Compatibility
This does not break anything and does not affect the CSS in any way. However, it improves issues and PRs.
Caveats
This post already uses the new template! :)
Create a community communication channel
Another nice way to facilitate building a community around a project like this is to create a channel through which the community can discuss, brainstorm, and ask for support. I prefer Gitter for OSS projects, but something like a Slack workspace or a Discord server would work as well.
I’d also recommend starting to build a team to help you manage the project. Create an organization (I’d call it
old-school-css
, personally, but maybe that’s just me 🙃), transfer the repo to the organization, then start betting community members via the new chat channel. I’m suggesting this, so obviously I’d love to join that team, but it’s ultimately gonna be up to you. 😉build(deps): bump json5 and svg-url-loader
Bumps json5, json5 and svg-url-loader. These dependencies needed to be updated together. Updates
json5
from 1.0.1 to 2.2.3Release notes
Sourced from json5's releases.
... (truncated)
Changelog
Sourced from json5's changelog.
... (truncated)
Commits
c3a7524
2.2.394fd06d
docs: update CHANGELOG for v2.2.33b8cebf
docs(security): use GitHub security advisoriesf0fd9e1
docs: publish a security policy6a91a05
docs(template): bug -> bug report14f8cb1
2.2.210cc7ca
docs: update CHANGELOG for v2.2.27774c10
fix: add proto to objects and arraysedde30a
Readme: slight tweak to intro97286f8
Improve example in readmeUpdates
json5
from 2.1.0 to 2.2.3Release notes
Sourced from json5's releases.
... (truncated)
Changelog
Sourced from json5's changelog.
... (truncated)
Commits
c3a7524
2.2.394fd06d
docs: update CHANGELOG for v2.2.33b8cebf
docs(security): use GitHub security advisoriesf0fd9e1
docs: publish a security policy6a91a05
docs(template): bug -> bug report14f8cb1
2.2.210cc7ca
docs: update CHANGELOG for v2.2.27774c10
fix: add proto to objects and arraysedde30a
Readme: slight tweak to intro97286f8
Improve example in readmeUpdates
svg-url-loader
from 2.3.2 to 2.3.3Release notes
Sourced from svg-url-loader's releases.
Commits
757cd4f
2.3.3a37d5a0
chore: added DS_Store to gitignorec6011d3
Merge pull request #315 from bhovhannes/improvements90e1bdc
test: better jest config3bab05d
test: add Jest configuration758b647
perf: increase loader performance by avoiding re-parsing regexps90763c1
test: switched to Jest71857e7
Merge remote-tracking branch 'origin/master'39362ca
Update .renovaterc7d22d91
chore(deps): update dependency webpack to v4.34.0Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebase
will rebase this PR@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it@dependabot merge
will merge this PR after your CI passes on it@dependabot squash and merge
will squash and merge this PR after your CI passes on it@dependabot cancel merge
will cancel a previously requested merge and block automerging@dependabot reopen
will reopen this PR if it is closed@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)@dependabot use these labels
will set the current labels as the default for future PRs for this repo and language@dependabot use these reviewers
will set the current reviewers as the default for future PRs for this repo and language@dependabot use these assignees
will set the current assignees as the default for future PRs for this repo and language@dependabot use this milestone
will set the current milestone as the default for future PRs for this repo and languageYou can disable automated security fix PRs for this repo from the Security Alerts page.
build(deps): bump express from 4.16.4 to 4.18.2
Bumps express from 4.16.4 to 4.18.2.
Release notes
Sourced from express's releases.
... (truncated)
Changelog
Sourced from express's changelog.
... (truncated)
Commits
8368dc1
4.18.261f4049
docs: replace Freenode with Libera Chatbb7907b
build: [email protected]f56ce73
build: [email protected]24b3dc5
deps: [email protected]689d175
deps: [email protected]340be0f
build: [email protected]33e8dc3
docs: use Node.js name style644f646
build: [email protected]ecd7572
build: [email protected]Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebase
will rebase this PR@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it@dependabot merge
will merge this PR after your CI passes on it@dependabot squash and merge
will squash and merge this PR after your CI passes on it@dependabot cancel merge
will cancel a previously requested merge and block automerging@dependabot reopen
will reopen this PR if it is closed@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)@dependabot use these labels
will set the current labels as the default for future PRs for this repo and language@dependabot use these reviewers
will set the current reviewers as the default for future PRs for this repo and language@dependabot use these assignees
will set the current assignees as the default for future PRs for this repo and language@dependabot use this milestone
will set the current milestone as the default for future PRs for this repo and languageYou can disable automated security fix PRs for this repo from the Security Alerts page.
build(deps): bump qs and express
Bumps qs, qs and express. These dependencies needed to be updated together. Updates
qs
from 6.6.0 to 6.11.0Changelog
Sourced from qs's changelog.
... (truncated)
Commits
56763c1
v6.11.0ddd3e29
[readme] fix version badgec313472
[New] [Fix]stringify
: revert 0e903c0; addcommaRoundTrip
option95bc018
v6.10.50e903c0
[Fix]stringify
: witharrayFormat: comma
, properly include an explicit `[...ba9703c
v6.10.44e44019
[Fix]stringify
: witharrayFormat: comma
, include an explicit[]
on a s...113b990
[Dev Deps] updateobject-inspect
c77f38f
[Dev Deps] updateeslint
,@ljharb/eslint-config
,aud
,has-symbol
,tape
2cf45b2
[meta] usenpmignore
to autogenerate an npmignore fileUpdates
qs
from 6.5.2 to 6.11.0Changelog
Sourced from qs's changelog.
... (truncated)
Commits
56763c1
v6.11.0ddd3e29
[readme] fix version badgec313472
[New] [Fix]stringify
: revert 0e903c0; addcommaRoundTrip
option95bc018
v6.10.50e903c0
[Fix]stringify
: witharrayFormat: comma
, properly include an explicit `[...ba9703c
v6.10.44e44019
[Fix]stringify
: witharrayFormat: comma
, include an explicit[]
on a s...113b990
[Dev Deps] updateobject-inspect
c77f38f
[Dev Deps] updateeslint
,@ljharb/eslint-config
,aud
,has-symbol
,tape
2cf45b2
[meta] usenpmignore
to autogenerate an npmignore fileUpdates
express
from 4.16.4 to 4.18.2Release notes
Sourced from express's releases.
... (truncated)
Changelog
Sourced from express's changelog.
... (truncated)
Commits
8368dc1
4.18.261f4049
docs: replace Freenode with Libera Chatbb7907b
build: [email protected]f56ce73
build: [email protected]24b3dc5
deps: [email protected]689d175
deps: [email protected]340be0f
build: [email protected]33e8dc3
docs: use Node.js name style644f646
build: [email protected]ecd7572
build: [email protected]Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebase
will rebase this PR@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it@dependabot merge
will merge this PR after your CI passes on it@dependabot squash and merge
will squash and merge this PR after your CI passes on it@dependabot cancel merge
will cancel a previously requested merge and block automerging@dependabot reopen
will reopen this PR if it is closed@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)@dependabot use these labels
will set the current labels as the default for future PRs for this repo and language@dependabot use these reviewers
will set the current reviewers as the default for future PRs for this repo and language@dependabot use these assignees
will set the current assignees as the default for future PRs for this repo and language@dependabot use this milestone
will set the current milestone as the default for future PRs for this repo and languageYou can disable automated security fix PRs for this repo from the Security Alerts page.
build(deps): bump decode-uri-component from 0.2.0 to 0.2.2
Bumps decode-uri-component from 0.2.0 to 0.2.2.
Release notes
Sourced from decode-uri-component's releases.
Commits
a0eea46
0.2.2980e0bf
Prevent overwriting previously decoded tokens3c8a373
0.2.176abc93
Switch to GitHub workflows746ca5d
Fix issue where decode throws - fixes #6486d7e2
Update license (#1)a650457
Tidelift tasks66e1c28
Meta tweaksDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebase
will rebase this PR@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it@dependabot merge
will merge this PR after your CI passes on it@dependabot squash and merge
will squash and merge this PR after your CI passes on it@dependabot cancel merge
will cancel a previously requested merge and block automerging@dependabot reopen
will reopen this PR if it is closed@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)@dependabot use these labels
will set the current labels as the default for future PRs for this repo and language@dependabot use these reviewers
will set the current reviewers as the default for future PRs for this repo and language@dependabot use these assignees
will set the current assignees as the default for future PRs for this repo and language@dependabot use this milestone
will set the current milestone as the default for future PRs for this repo and languageYou can disable automated security fix PRs for this repo from the Security Alerts page.