Skip to content

Commit

Permalink
README.md - add explanation of uppy.io/docs VS uppy.io/blog
Browse files Browse the repository at this point in the history
  • Loading branch information
lakesare committed May 15, 2024
1 parent 89a457a commit 6c30c24
Showing 1 changed file with 39 additions and 6 deletions.
45 changes: 39 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,32 @@
# Uppy.io

Website and documentation for [uppy](https://uppy.io/).
Website and documentation for [uppy.io](https://uppy.io).

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern
static website generator.
Code for [uppy.io/blog](https://uppy.io/blog) lives in this repo.
Code for [uppy.io/docs](https://uppy.io/docs/quick-start) lives in
[github.com/transloadit/uppy](https://github.com/transloadit/uppy).

## Developer guide

### Installation
If you want to edit [uppy.io/blog](https://uppy.io/blog), just edit the files in
this repo.

If you want to edit [uppy.io/docs](https://uppy.io/docs/quick-start), then you
should:

1. Clone both the **uppy** repo and **uppy.io** repo.

2. Then, from your **/uppy.io** repo, run:

```sh
ln -s /path-to-your-uppy-repo/docs docs
```

Now, treat **/uppy/docs** as your working directory, but run the build/lint
scripts from your **/uppy.io** directory - **/uppy.io** will pick up your
changes.

### Install Dependencies

```sh
corepack yarn
Expand All @@ -19,8 +38,17 @@ corepack yarn
corepack yarn dev
```

This command starts a local development server and opens up a browser window.
Most changes are reflected live without having to restart the server.
This command builds **/uppy/docs** and **/uppy.io**, and shows them in a
browser. Most changes are reflected live without having to restart the server.

### Lint

```sh
corepack yarn run format
corepack yarn lint
```

This command lints **/uppy/docs** and **/uppy.io**.

### Build

Expand All @@ -30,3 +58,8 @@ corepack yarn build

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

---

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

0 comments on commit 6c30c24

Please sign in to comment.