Skip to content

Commit a1b7662

Browse files
luizbaldiarturbien
authored andcommitted
Improve docs structure
* Move each mdx file to respective component folder (colocation ftw) * Fix some style prop-types in order to fix docz build * Move docz to the root folder instead of having a separated project folder
1 parent 8d238a4 commit a1b7662

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+7129
-13851
lines changed

docs/.env renamed to .env

File renamed without changes.

.eslintrc.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ module.exports = {
2121
'jsx-a11y/label-has-associated-control': ['error', { assert: 'either' }],
2222
'jsx-a11y/label-has-for': 'off',
2323
'prettier/prettier': 'error',
24-
'react/no-array-index-key': 'off'
24+
'react/no-array-index-key': 'off',
25+
'react/forbid-prop-types': 'off'
2526
}
2627
};

.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ yarn-error.log*
2626
.idea/*
2727

2828
# Docs
29-
docs/node_modules
30-
docs/.docz
29+
.docz
30+
/docs/build

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<h1 align="center">React95</h1>
22

33
<p align="center">
4-
<a href="https://www.npmjs.com/package/react95"><img src="https://flat.badgen.net/npm/dt/react95" alt="NPM"></a>
5-
<a href="https://www.npmjs.com/package/react95"><img src="https://flat.badgen.net/npm/v/react95" alt="React95 version"></a>
6-
<a href="https://www.npmjs.com/package/react95"><img src="https://flat.badgen.net/npm/license/react95" alt="React95 license"></a>
4+
<a href="https://www.npmjs.com/package/react95"><img src="https://flat.badgen.net/npm/dt/react95" alt="NPM" /></a>
5+
<a href="https://www.npmjs.com/package/react95"><img src="https://flat.badgen.net/npm/v/react95" alt="React95 version" /></a>
6+
<a href="https://www.npmjs.com/package/react95"><img src="https://flat.badgen.net/npm/license/react95" alt="React95 license" /></a>
77

88
</p>
99
<h3 align="center">
@@ -13,7 +13,7 @@
1313
<a href="https://www.paypal.me/react95">PayPal donation 💰</a>
1414
</h3>
1515
<p align="center">
16-
<b>Refreshed</b> Windows95 UI components for your modern React apps. <br> Built with styled-components 💅</p>
16+
<b>Refreshed</b> Windows95 UI components for your modern React apps. <br /> Built with styled-components 💅</p>
1717

1818
![demo](https://user-images.githubusercontent.com/28541613/56099388-7513f800-5f0c-11e9-893b-532eded39f92.png)
1919

@@ -88,6 +88,8 @@ Any help from UI / UX designers would be EXTREMELY appreciated. The challenge is
8888

8989
There's a lot to do. If you want to help with the project, feel free to open pull requests and submit issues. Let's make UI great again 🔥
9090

91+
For every component, we have a `.stories` file for Storybook and a `.mdx` file for Docz. In order to create a `.mdx` file we recommend copying [this template](https://github.com/arturbien/React95/blob/chore/docs-docz/docs/template) file and replaceing ___component_ with the component name.
92+
9193
### Roadmap
9294

9395
There's quite a few things to be done:
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/package.json

-32
This file was deleted.

docs/tsconfig.json

-12
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)