Skip to content

Commit cdae997

Browse files
committed
fix(README): rollback to pre-docusaurus
1 parent bfa093d commit cdae997

File tree

2 files changed

+10
-32
lines changed

2 files changed

+10
-32
lines changed

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
registry=https://registry.npmjs.org/
12
package-lock=false

README.md

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,18 @@
1-
# Website
1+
# Downshift Docs
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
3+
Repository that hosts the Downshift Docsite. All Downshift examples should be hosted here, along with links to their Codesandbox equivalents, which should be hosted on the [examples repository](https://github.com/downshift-js/downshift-examples).
44

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

7-
```
8-
$ yarn
9-
```
10-
11-
### Local Development
12-
13-
```
14-
$ yarn start
15-
```
16-
17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18-
19-
### Build
7+
```sh
8+
npm install
209

10+
npm run serve
2111
```
22-
$ yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
### Deployment
28-
29-
Using SSH:
3012

31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
13+
This will start the `docusaurus` app in development mode.
3414

35-
Not using SSH:
3615

37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
16+
## Contribute
4017

41-
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.
18+
A great opportunity is to have all the sandboxes of the examples from this docsite in the examples repository. Also to have all examples from the examples repository hosted on the docsite as well.

0 commit comments

Comments
 (0)