Skip to content

Commit ccc4e1c

Browse files
authored
Update local development instructions in README
1 parent 2db712e commit ccc4e1c

1 file changed

Lines changed: 7 additions & 19 deletions

File tree

README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,14 @@ $ npm i
1010

1111
### Local Development
1212

13+
To build the docs on local machine, the project expects to have [Reactodia Workspace repository](https://github.com/reactodia/reactodia-workspace) to be checked out at `../reactodia-workspace` (i.e. in `reactodia-workspace` directory at the parent directory for the docs itself). This is necessary to generate API Reference for the library using [docusaurus-plugin-typedoc](https://typedoc-plugin-markdown.org/plugins/docusaurus).
14+
1315
```shell
1416
$ npm run start
1517
```
1618

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

19-
To see embedded interactive examples at `/interactive-examples` create a symbolic link (or junction point on Windows) into compiled example bundles directory as `static/examples`.
20-
21-
For example, on Windows using `cmd`:
22-
```shell
23-
reactodia.github.io\static> mklink /j examples ../../reactodia-workspace/dist/examples
24-
```
25-
2621
### Build
2722

2823
```shell
@@ -31,18 +26,11 @@ $ npm run build
3126

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

34-
### Deployment
35-
36-
Using SSH:
37-
38-
```
39-
$ USE_SSH=true yarn deploy
29+
Run the following command to test the built assets locally:
30+
```shell
31+
$ npm run serve
4032
```
4133

42-
Not using SSH:
43-
44-
```
45-
$ GIT_USER=<Your GitHub username> yarn deploy
46-
```
34+
### Deployment
4735

48-
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.
36+
The docs are deployed to the GitHub Pages using [Deploy to GitHub pages](https://github.com/reactodia/reactodia.github.io/actions/workflows/deploy-pages.yml) action workflow.

0 commit comments

Comments
 (0)