Skip to content

Commit 9f5a795

Browse files
Rubix982Rubix982
committed
Shifted from common template with Facebook Open Source
Signed-off-by: Saif Ul Islam <[email protected]>
1 parent 8192178 commit 9f5a795

35 files changed

+2009
-5670
lines changed

‎docs/.eslintrc.js‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/**
2+
* Copyright (c) Facebook, Inc. and its affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @format
8+
*/
9+
10+
const OFF = 0;
11+
const WARNING = 1;
12+
const ERROR = 2;
13+
14+
module.exports = {
15+
root: true,
16+
env: {
17+
browser: true,
18+
commonjs: true,
19+
jest: true,
20+
node: true,
21+
},
22+
parser: '@babel/eslint-parser',
23+
parserOptions: {
24+
allowImportExportEverywhere: true,
25+
},
26+
extends: ['airbnb', 'prettier', 'prettier/react'],
27+
plugins: ['react-hooks', 'header'],
28+
rules: {
29+
// Ignore certain webpack alias because it can't be resolved
30+
'import/no-unresolved': [
31+
ERROR,
32+
{ignore: ['^@theme', '^@docusaurus', '^@generated']},
33+
],
34+
'import/extensions': OFF,
35+
'header/header': [
36+
ERROR,
37+
'block',
38+
39+
[
40+
'*',
41+
' * Copyright (c) Facebook, Inc. and its affiliates.',
42+
' *',
43+
' * This source code is licensed under the MIT license found in the',
44+
' * LICENSE file in the root directory of this source tree.',
45+
' *',
46+
// Unfortunately eslint-plugin-header doesn't support optional lines.
47+
// If you want to enforce your website JS files to have @flow or @format,
48+
// modify these lines accordingly.
49+
{
50+
pattern: '.* @format',
51+
},
52+
' ',
53+
],
54+
],
55+
'react/jsx-closing-bracket-location': OFF, // Conflicts with Prettier.
56+
'react/jsx-filename-extension': OFF,
57+
'react-hooks/rules-of-hooks': ERROR,
58+
'react/prop-types': OFF, // PropTypes aren't used much these days.
59+
},
60+
};

‎docs/.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@
1818
npm-debug.log*
1919
yarn-debug.log*
2020
yarn-error.log*
21+
22+
# ESLint
23+
.eslintcache

‎docs/.prettierignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
build
3+
.docusaurus

‎docs/.prettierrc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"arrowParens": "always",
3+
"bracketSpacing": false,
4+
"jsxBracketSameLine": true,
5+
"printWidth": 80,
6+
"proseWrap": "never",
7+
"singleQuote": true,
8+
"trailingComma": "all"
9+
}

‎docs/.stylelintrc.js‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
/**
2+
* Copyright (c) Facebook, Inc. and its affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*/
7+
8+
module.exports = {
9+
plugins: ['stylelint-copyright'],
10+
rules: {
11+
'docusaurus/copyright-header': true,
12+
},
13+
};

‎docs/README.md‎

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,40 @@
22

33
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
44

5-
## Installation
5+
### Installation
66

7-
```console
8-
yarn install
7+
```
8+
$ yarn
99
```
1010

11-
## Local Development
11+
### Local Development
1212

13-
```console
14-
yarn start
13+
```
14+
$ yarn start
1515
```
1616

1717
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1818

19-
## Build
19+
### Build
2020

21-
```console
22-
yarn build
21+
```
22+
$ yarn build
2323
```
2424

2525
This command generates static content into the `build` directory and can be served using any static contents hosting service.
2626

27-
## Deployment
27+
### Deployment
2828

29-
```console
30-
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
29+
```
30+
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
3131
```
3232

3333
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
34+
35+
### Continuous Integration
36+
37+
Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.
38+
39+
```
40+
$ yarn ci
41+
```

‎docs/babel.config.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
/**
2+
* Copyright (c) Facebook, Inc. and its affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @format
8+
*/
9+
110
module.exports = {
211
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
312
};

docs/blog/2019-05-28-hola.md renamed to docs/blog/2019-05-28-first-blog-post.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
slug: hola
3-
title: Hola
4-
author: Gao Wei
5-
author_title: Docusaurus Core Team
6-
author_url: https://github.com/wgao19
7-
author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4
2+
slug: first-blog-post
3+
title: First Blog Post
4+
authors:
5+
name: Gao Wei
6+
title: Docusaurus Core Team
7+
url: https://github.com/wgao19
8+
image_url: https://github.com/wgao19.png
89
tags: [hola, docusaurus]
910
---
1011

‎docs/blog/2019-05-29-hello-world.md‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎docs/blog/2019-05-29-long-blog-post.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
slug: long-blog-post
3+
title: Long Blog Post
4+
authors: endi
5+
tags: [hello, docusaurus]
6+
---
7+
8+
This is the summary of a very long blog post,
9+
10+
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
11+
12+
<!--truncate-->
13+
14+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
15+
16+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17+
18+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
19+
20+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
21+
22+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
23+
24+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
25+
26+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
27+
28+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
29+
30+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
31+
32+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
33+
34+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
35+
36+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
37+
38+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
39+
40+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
41+
42+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
43+
44+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

0 commit comments

Comments
 (0)