Skip to content

Commit

Permalink
Add components dir and split css file (#224)
Browse files Browse the repository at this point in the history
* refactor: add components directory

ref #166

* build: split nes.scss into nes.css and nes-core.css

and change npm scripts for build

ref #166

* docs(readme.md): add nes-core.css link

* docs: add components directory path

and minor modification of the document
  • Loading branch information
BcRikko authored and abdallahalsamman committed Dec 28, 2018
1 parent 15aab67 commit 3eacba9
Show file tree
Hide file tree
Showing 19 changed files with 3,629 additions and 3,589 deletions.
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT-es.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Código de Conducta convenido para Contribuyentes

Ver este documento en otro idioma:
[简体中文](.github/CONTRIBUTING-zh-CN.md) / [English](CONTRIBUTING.md) / [日本語](.github/CONTRIBUTING-jp.md) / [Português](.github/CONTRIBUTING-pt-BR.md)
[English](CONTRIBUTING.md) / [日本語](.github/CONTRIBUTING-jp.md) / [简体中文](.github/CONTRIBUTING-zh-CN.md) / [Português](.github/CONTRIBUTING-pt-BR.md)

## Nuestro compromiso

Expand Down
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT-jp.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# コントリビューター行動規範

このドキュメントを別の言語で表示する:
[简体中文](.github/CONTRIBUTING-zh-CN.md) / [English](CONTRIBUTING.md) / [Español](.github/CONTRIBUTING-es.md) / [Português](.github/CONTRIBUTING-pt-BR.md)
[English](CONTRIBUTING.md) / [简体中文](.github/CONTRIBUTING-zh-CN.md) / [Español](.github/CONTRIBUTING-es.md) / [Português](.github/CONTRIBUTING-pt-BR.md)

## 私たちの約束

Expand Down
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT-pt-BR.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Código de Conduta para Colaboradores

Veja este documento em outro idioma:
[简体中文](.github/CONTRIBUTING-zh-CN.md) / [English](CONTRIBUTING.md) / [日本語](.github/CONTRIBUTING-jp.md) / [Español](.github/CONTRIBUTING-es.md)
[English](CONTRIBUTING.md) / [日本語](.github/CONTRIBUTING-jp.md) / [简体中文](.github/CONTRIBUTING-zh-CN.md) / [Español](.github/CONTRIBUTING-es.md)

## Nossa promessa

Expand Down
3 changes: 2 additions & 1 deletion .github/CONTRIBUTING-es.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contribución

Ver este documento en otro idioma:
[简体中文](CONTRIBUTING-zh-CN.md) / [English](CONTRIBUTING.md) / [日本語](.github/CONTRIBUTING-jp.md) / [Português](.github/CONTRIBUTING-pt-BR.md)
[English](CONTRIBUTING.md) / [日本語](.github/CONTRIBUTING-jp.md) / [简体中文](CONTRIBUTING-zh-CN.md) / [Português](.github/CONTRIBUTING-pt-BR.md)

¿Quieres contribuir al proyecto? ¡Genial!

Expand Down Expand Up @@ -53,6 +53,7 @@ Este proyecto se apega al Código de Conducta convenido para Contribuyentes. Al
│ ├── generic.scss: Estilo general y reboot.css
│ └── variables.scss: Variables comunes
├── elements
├── components
├── form
├── icons: Iconos 16x16
├── pixel-arts: Para iconos que no son 16x16.
Expand Down
3 changes: 2 additions & 1 deletion .github/CONTRIBUTING-jp.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 貢献する

このドキュメントを別の言語で表示する:
[简体中文](CONTRIBUTING-zh-CN.md) / [English](CONTRIBUTING.md) / [Español](.github/CONTRIBUTING-es.md) / [Português](.github/CONTRIBUTING-pt-BR.md)
[English](CONTRIBUTING.md) / [简体中文](CONTRIBUTING-zh-CN.md) / [Español](.github/CONTRIBUTING-es.md) / [Português](.github/CONTRIBUTING-pt-BR.md)

このプロジェクトに貢献したいですか?素晴らしい!

Expand Down Expand Up @@ -53,6 +53,7 @@
│ ├── generic.scss: 一般的なスタイルとreboot.cssの上書き
│ └── variables.scss: 共通変数
├── elements
├── components
├── form
├── icons: 16x16のアイコン
├── pixel-arts: 16x16以外のアイコン
Expand Down
3 changes: 2 additions & 1 deletion .github/CONTRIBUTING-pt-BR.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contribuindo

Veja este documento em outro idioma:
[简体中文](CONTRIBUTING-zh-CN.md) / [English](CONTRIBUTING.md) / [日本語](.github/CONTRIBUTING-jp.md) / [Español](.github/CONTRIBUTING-es.md)
[English](CONTRIBUTING.md) / [日本語](.github/CONTRIBUTING-jp.md) / [简体中文](CONTRIBUTING-zh-CN.md) / [Español](.github/CONTRIBUTING-es.md)

Quer contribuir para este projeto? Legal!

Expand Down Expand Up @@ -53,6 +53,7 @@ Nós estamos muito felizes de você querer contribuir para o projeto! Os próxim
│ ├── generic.scss: Estilização genérica e reboot.css
│ └── variables.scss: Variáveis em comum
├── elements
├── components
├── form
├── icons: 16x16 icons
├── pixel-arts: Para ícones que não são 16x16.
Expand Down
1 change: 1 addition & 0 deletions .github/CONTRIBUTING-zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
│ ├── generic.scss: Generic style and reboot.css
│ └── variables.scss: Common variables
├── elements
├── components
├── form
├── icons: 16x16 icons
├── pixel-arts: For icons other than 16x16.
Expand Down
6 changes: 4 additions & 2 deletions .github/README-es.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">
<a href="https://nostalgic-css.github.io/NES.css/" target="_blank"><img src="https://user-images.githubusercontent.com/5305599/49061716-da649680-f254-11e8-9a89-d95a7407ec6a.png" alt="NES.css: NES-style CSS framework" style="max-width: 100%;" width="600" height="315"></a>

<a href="README-zh-CN.md">简体中文</a> / <a href="README.md">English</a> / <a href=".github/README-jp.md">日本語</a> / <a href=".github/README-pt-BR.md">Português</a>
<a href="README.md">English</a> / <a href=".github/README-jp.md">日本語</a> / <a href="README-zh-CN.md">简体中文</a> / <a href=".github/README-pt-BR.md">Português</a>
</div>

NES.css is a **NES-style(8bit-like)** CSS Framework.
Expand Down Expand Up @@ -32,9 +32,11 @@ Importa el CSS utiliando un elemento `<link />`:

```html
<!-- minificado -->
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.min.css" rel="stylesheet" />
<link href="https://unpkg.com/nes.css@1.0.0/css/nes.min.css" rel="stylesheet" />
<!-- último -->
<link href="https://unpkg.com/nes.css/css/nes.min.css" rel="stylesheet" />
<!-- solo estilo del núcleo -->
<link href="https://unpkg.com/nes.css/css/nes-core.min.css" rel="stylesheet" />
```

### Tipografías
Expand Down
10 changes: 6 additions & 4 deletions .github/README-jp.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">
<a href="https://nostalgic-css.github.io/NES.css/" target="_blank"><img src="https://user-images.githubusercontent.com/5305599/49061716-da649680-f254-11e8-9a89-d95a7407ec6a.png" alt="NES.css: NES-style CSS framework" style="max-width: 100%;" width="600" height="315"></a>

<a href="README-zh-CN.md">简体中文</a> / <a href="README.md">English</a> / <a href="README-es.md">Español</a> / <a href="README-pt-BR.md">Português</a>
<a href="README.md">English</a> / <a href="README-zh-CN.md">简体中文</a> / <a href="README-es.md">Español</a> / <a href="README-pt-BR.md">Português</a>
</div>

NES.cssは **ファミコン風(8bit ライク)** なCSSフレームワークです。
Expand Down Expand Up @@ -31,10 +31,12 @@ yarn add nes.css
`<link />`要素を使ってCSSをインポートする:

```html
<!-- minify -->
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.min.css" rel="stylesheet" />
<!-- latest -->
<!-- 圧縮版 -->
<link href="https://unpkg.com/nes.css@1.0.0/css/nes.min.css" rel="stylesheet" />
<!-- 最新版 -->
<link href="https://unpkg.com/nes.css/css/nes.min.css" rel="stylesheet" />
<!-- コアスタイルのみ -->
<link href="https://unpkg.com/nes.css/css/nes-core.min.css" rel="stylesheet" />
```

### フォント
Expand Down
6 changes: 4 additions & 2 deletions .github/README-pt-BR.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">
<a href="https://nostalgic-css.github.io/NES.css/" target="_blank"><img src="https://user-images.githubusercontent.com/5305599/49061716-da649680-f254-11e8-9a89-d95a7407ec6a.png" alt="NES.css: NES-style CSS framework" style="max-width: 100%;" width="600" height="315"></a>

<a href="README-zh-CN.md">简体中文</a> / <a href="README.md">English</a> / <a href=".github/README-jp.md">日本語</a> / <a href=".github/README-es.md">Español</a>
<a href="README.md">English</a> / <a href=".github/README-jp.md">日本語</a> / <a href="README-zh-CN.md">简体中文</a> / <a href=".github/README-es.md">Español</a>
</div>

NES.css é um Framework CSS, no **estilo NES(8bit)**.
Expand Down Expand Up @@ -32,9 +32,11 @@ Importe o CSS através de um elemento `<link />`:

```html
<!-- minify -->
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.min.css" rel="stylesheet" />
<link href="https://unpkg.com/nes.css@1.0.0/css/nes.min.css" rel="stylesheet" />
<!-- latest -->
<link href="https://unpkg.com/nes.css/css/nes.min.css" rel="stylesheet" />
<!-- core style only -->
<link href="https://unpkg.com/nes.css/css/nes-core.min.css" rel="stylesheet" />
```

### Fontes
Expand Down
81 changes: 18 additions & 63 deletions .github/README-zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,35 @@ NES.css 是一款 **NES-风格(8位机)** 的CSS 框架.

## 安装

### CDN
#### via package manager

```html
<!-- minify -->
<link href="https://unpkg.com/[email protected]/css/nes.min.css" rel="stylesheet" />
<!-- latest -->
<link href="https://unpkg.com/nes.css/css/nes.min.css" rel="stylesheet" />
```shell
npm install nes.css
# or
yarn add nes.css
```

或者
### via CDN

```html
<!-- non-minified -->
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.css" rel="stylesheet" />
<link href="https://unpkg.com/nes.css@1.0.0/css/nes.min.css" rel="stylesheet" />
<!-- latest -->
<link href="https://unpkg.com/nes.css/css/nes.css" rel="stylesheet" />
<!-- core style only -->
<link href="https://unpkg.com/nes.css/css/nes-core.min.css" rel="stylesheet" />
```

### npm
### 推荐字体

|Language|Font|
|----|----|
|(Default)|[Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P)|
|English|[Kongtext](https://www.dafont.com/kongtext.font)|
|Japanese|[美咲フォント](http://www.geocities.jp/littlimi/misaki.htm)|
|Japanese|[Nu もち](http://kokagem.sakura.ne.jp/font/mochi/)|
| Korean|[둥근모꼴](http://cactus.tistory.com/193)|

TODO: npm での使用方法を書く

## 使用

Expand All @@ -50,16 +58,6 @@ NES.css 只提供组件. 你需要定义你自己的布局.
</head>
```

### 推荐字体

|Language|Font|
|----|----|
|(Default)|[Press Start 2P](https://fonts.google.com/specimen/Press+Start+2P)|
|English|[Kongtext](https://www.dafont.com/kongtext.font)|
|Japanese|[美咲フォント](http://www.geocities.jp/littlimi/misaki.htm)|
|Japanese|[Nu もち](http://kokagem.sakura.ne.jp/font/mochi/)|


## 只需要CSS

NES.css 仅仅需要 CSS 而不依赖其他任何 JavaScript.
Expand All @@ -76,55 +74,12 @@ NES.css 与如下浏览器的最新版本兼容.
* IE/Edge


## 开发

### 命令
```sh
git clone [email protected]:BcRikko/NES.css.git
cd NES.css

npm i

npm run watch
npm run build
```

#### 运行 Storybook
```
npm run storybook
```

在预提交阶段Linting, 格式化以及构建都会自动运行.
TODO: ビルドはCIでするように変更したい

### 目录结构
```sh
.
├── index.html: Demo page
├── style.css: Demo page style
├── css: Distribution files
├── docs: Storybook stories
└── scss: Source
├── base
│ ├── reboot.scss: Don't change! (Bootstrap Reboot)
│ ├── generic.scss: Generic style and reboot.css
│ └── variables.scss: Common variables
├── elements
├── form
├── icons: 16x16 icons
├── pixel-arts: For icons other than 16x16.
└── utilities
```
## 版权许可

代码以及文档版权 2018 [B.C.Rikko](https://github.com/BcRikko). 代码基于MIT许可发布. 文档基于Creative Commons许可发布.




[gitter]: https://gitter.im/nostalgic-css/Lobby
[gitter-badge]: https://img.shields.io/gitter/room/nostalgic-css/Lobby.svg
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ We're really happy you want to contribute to the project! ❤️ The following s
│ ├── generic.scss: Generic style and reboot.css
│ └── variables.scss: Common variables
├── elements
├── components
├── form
├── icons: 16x16 icons
├── pixel-arts: For icons other than 16x16.
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">
<a href="https://nostalgic-css.github.io/NES.css/" target="_blank"><img src="https://user-images.githubusercontent.com/5305599/49061716-da649680-f254-11e8-9a89-d95a7407ec6a.png" alt="NES.css: NES-style CSS framework" style="max-width: 100%;" width="600" height="315"></a>

<a href=".github/README-zh-CN.md">简体中文</a> / <a href=".github/README-jp.md">日本語</a> / <a href=".github/README-es.md">Español</a> / <a href=".github/README-pt-BR.md">Português</a>
<a href=".github/README-jp.md">日本語</a> / <a href=".github/README-zh-CN.md">简体中文</a> / <a href=".github/README-es.md">Español</a> / <a href=".github/README-pt-BR.md">Português</a>
</div>

NES.css is a **NES-style(8bit-like)** CSS Framework.
Expand Down Expand Up @@ -32,9 +32,11 @@ Import the CSS via a `<link />` element:

```html
<!-- minify -->
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.min.css" rel="stylesheet" />
<link href="https://unpkg.com/nes.css@1.0.0/css/nes.min.css" rel="stylesheet" />
<!-- latest -->
<link href="https://unpkg.com/nes.css/css/nes.min.css" rel="stylesheet" />
<!-- core style only -->
<link href="https://unpkg.com/nes.css/css/nes-core.min.css" rel="stylesheet" />
```

### Fonts
Expand Down
Loading

0 comments on commit 3eacba9

Please sign in to comment.