NES.css README

The project's README from github.com/nostalgic-css/NES.css. As one markdown file: README.md.

NES.css: NES-style  CSS framework

日本語 / 简体中文 / Español / Português / Русский / Français

NES.css is a NES-style(8bit-like) CSS Framework.

Gitter Commitizen friendly

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:

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/nes.css@latest/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:

Untested

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!

NES.css (nostalgic-css/NES.css)

Searching Database…

21.8K ·GitHub
What is this?NES.css is a CSS framework that styles HTML components with a NES (Famicom) 8-bit retro-game look, as if your web page were a game on the old console.
Is it a full framework with a grid and layout system, or just component styling?Just component styling. NES.css only provides styled components — you have to define your own page layout yourself.
How do I add it to my project?Install it with npm (preferred) or Yarn, or skip the package manager entirely and import the CSS from a CDN with a link element. Sass/SCSS users can import the Sass source directly.
Do I need to include any JavaScript for it to work?No. NES.css is CSS-only with zero runtime JavaScript dependencies — you just load the stylesheet. The only exception is importing it through a bundler, which needs css-loader.
My text looks off — does the retro style need a special font?Yes, and it is not bundled: NES.css ships no fonts. Press Start 2P is the recommended default, but it covers only English characters, so for Japanese, Korean or Chinese text you should pick one of the dedicated pixel fonts the README lists.
Which browsers does it work in?It targets the newest versions of Chrome, Firefox and Safari. Internet Explorer and Edge are untested.
Is it free to use in my own projects?Yes. The code is released under the MIT License and the documentation under Creative Commons — free to use, including commercially.
Can I import the Sass sources instead of the compiled CSS?Yes. The package exposes its main Sass source file, so Sass and SCSS users can pull in the sources directly instead of the compiled CSS.
How would I customize the styles and rebuild it from source?Clone the repo and use its npm build scripts: they compile the Sass, add vendor prefixes and minify the CSS. Building requires Node 10 or newer.
Why is it called NES.css?It imitates the look of the NES (Nintendo Entertainment System, sold as the Famicom in Japan) — the Japanese part of the project description literally reads 'Famicom-style CSS framework'.
What are similar projects?css, yeti, mdb-ui-kit, Flat-UI, materialize, daisyui, weui, 98.css
Size
4.6 MB
Stars
21.8K
Age
8y
Commits · 90 Days