https://github.com/afeiship/react-gh2project

React github pages to project.
https://github.com/afeiship/react-gh2project

gh-pages icon project react

Last synced: about 1 month ago
JSON representation

React github pages to project.

• Host: GitHub
• URL: https://github.com/afeiship/react-gh2project
• Owner: afeiship
• License: mit
• Created: 2020-02-13T17:26:27.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-03T08:22:27.000Z (almost 4 years ago)
• Last Synced: 2024-10-28T07:30:24.137Z (3 months ago)
• Topics: gh-pages, icon, project, react
• Language: JavaScript
• Size: 113 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# react-gh2project

> React github pages to project.

[![version][version-image]][version-url]

[![license][license-image]][license-url]

[![size][size-image]][size-url]

[![download][download-image]][download-url]

## installation

```shell

npm install -S @jswork/react-gh2project

```

## properties

| Name      | Type   | Required | Default | Description                           |

| --------- | ------ | -------- | ------- | ------------------------------------- |

| className | string | false    | -       | The extended className for component. |

| href      | string | false    | -       | Default value.                        |

## usage

1. import css

  ```scss

  @import "~@jswork/react-gh2project/dist/style.css";

  // or use sass

  @import "~@jswork/react-gh2project/dist/style.scss";

  // customize your styles:

  $react-gh2project-options: ()

  ```

2. import js

  ```js

  import ReactDemokit from '@jswork/react-demokit';

  import React from 'react';

  import ReactDOM from 'react-dom';

  import ReactGh2project from '@jswork/react-gh2project';

  import './assets/style.scss';

  class App extends React.Component {

    render() {

      return (

        

          

          

        

      );

    }

  }

  ReactDOM.render(, document.getElementById('app'));

  ```

## documentation

- https://afeiship.github.io/react-gh2project/

## license

Code released under [the MIT license](https://github.com/afeiship/react-gh2project/blob/master/LICENSE.txt).

[version-image]: https://img.shields.io/npm/v/@jswork/react-gh2project

[version-url]: https://npmjs.org/package/@jswork/react-gh2project

[license-image]: https://img.shields.io/npm/l/@jswork/react-gh2project

[license-url]: https://github.com/afeiship/react-gh2project/blob/master/LICENSE.txt

[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/react-gh2project

[size-url]: https://github.com/afeiship/react-gh2project/blob/master/dist/react-gh2project.min.js

[download-image]: https://img.shields.io/npm/dm/@jswork/react-gh2project

[download-url]: https://www.npmjs.com/package/@jswork/react-gh2project