Skip to content

Commit

Permalink
feat: docz page file
Browse files Browse the repository at this point in the history
  • Loading branch information
markcytian committed May 10, 2021
1 parent 639c1d0 commit 7dd3737
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docz/contributing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
name: 贡献 / Contributing
route: /contributing
menu: 入门 / Getting Started
---
11 changes: 11 additions & 0 deletions docz/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Introduction
route: /
---

import { Playground } from 'docz';
import { Radio, RadioGroup, Table } from '@components';

# NES-design

## React Game Style UI Component Library
54 changes: 54 additions & 0 deletions docz/start.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: 安装 / Install
route: /install
menu: 入门 / Getting Started
---

import { Text } from '@components';
import { Playground, TagVersion, Explain } from 'docz';

## Installation

<div style={{ marginTop: 30 }} />

### 1. Install NES-design

<Explain code="npm install nes-design" isCopyable/>

### 2. Install peerDependencies

<Explain code="npm install nes.css react@^16.8" isCopyable/>

### 3. Import css

<Explain code="import 'node_modules/nes-design/es/index.css'" isCopyable/>
<Explain code="import 'node_modules/nes.css/css/nes.css'" isCopyable/>

### 4. Use

<Explain code="import { Component } from 'nes-design'" isCopyable/>
<Explain code="import Component from 'nes-design/Component'" isCopyable/>

<div style={{ marginTop: 30 }} />

## custom theme

<div style={{ marginTop: 30 }} />

### 1. Remove nes.css css
<Text status="error" style={{ fontWeight: 'bold' }}>Cannot remove nes-design css</Text>

### 2. Create scss file And Import scss
<Explain code="import 'node_modules/nes.css/scss/nes.scss'" isCopyable/>

### 3. Cover scss theme variable

<Text>
<Text tag="a" href="https://github.com/nostalgic-css/NES.css/blob/develop/scss/base/variables.scss">
Theme variable
</Text>
</Text>

### 4. For Example

<Explain code="$base-color: red !default;" isCopyable/>

0 comments on commit 7dd3737

Please sign in to comment.