You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-19Lines changed: 7 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,19 +10,14 @@ $ npm i
10
10
11
11
### Local Development
12
12
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
+
13
15
```shell
14
16
$ npm run start
15
17
```
16
18
17
19
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
20
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`.
This command generates static content into the `build` directory and can be served using any static contents hosting service.
33
28
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
40
32
```
41
33
42
-
Not using SSH:
43
-
44
-
```
45
-
$ GIT_USER=<Your GitHub username> yarn deploy
46
-
```
34
+
### Deployment
47
35
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