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
+21-8Lines changed: 21 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,24 +12,37 @@ If you are working on the site, you will want to install and run a local copy of
12
12
All dependencies are installed with npm, just:
13
13
14
14
```sh
15
-
$ cd react-bootstrap
15
+
$ cd react-bootstrap/docs
16
16
$ npm install
17
17
```
18
18
19
19
### Instructions
20
20
21
-
The site uses React bootstrap components, so first make sure you've built the project (via `grunt`). Then:
21
+
#### Development
22
+
23
+
The site uses React bootstrap components, so first make sure you've installed and built the project (via `grunt`). Then:
22
24
23
25
```sh
24
-
$ cd react-bootstrap
25
-
$ grunt serveDocs
26
+
$ cd react-bootstrap/docs
27
+
$ npm start
26
28
$ open http://localhost:4000/
27
29
```
28
30
29
-
After making any modifications you will need to regenerate the site. Like:
31
+
This will start an express based node server which will generate static html content and the js bundle on request. After making any modifications the server should restart and regenerate any necessary files on the next request.
32
+
33
+
#### Production
34
+
35
+
This site is statically published on github pages, to do this the static assets need to be generated.
36
+
37
+
```sh
38
+
$ cd react-bootstrap/docs
39
+
$ npm run build
40
+
```
41
+
42
+
To test the static files you can use the included express based static file server.
30
43
31
44
```sh
32
-
$ cd react-bootstrap
33
-
$ grunt watch:docs # Automatically compiles as needed
0 commit comments