File tree Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Original file line number Diff line number Diff line change 3
3
This is the source for the [ nativescript-vue.org] ( https://nativescript-vue.org/ ) website.
4
4
5
5
Contributions are welcome, all the content is placed in the ` content ` directory.
6
+
7
+ ## How to build the documentation
8
+
9
+ After cloning the repository, do the following steps
10
+
11
+ ``` bash
12
+ cd nativescript-vue.org/
13
+ npm run build:js
14
+ npm run build:css
15
+ npm run build
16
+ ```
17
+
18
+ This sequence is only needed the first time. After that, the only command needed is:
19
+
20
+ ``` bash
21
+ npm run build
22
+ ```
23
+
24
+ ## Serve the documentation
25
+
26
+ Install the ` serve ` npm package globaly:
27
+
28
+ ``` bash
29
+ npm install -g serve
30
+ ```
31
+
32
+ Run the HTTP server using the already generated ` dist/ ` directory:
33
+
34
+ ``` bash
35
+ serve dist/
36
+ ```
37
+
38
+ Now, you can open the ` http://localhost:5000 ` URL in your browser to see the generated docs.
39
+
40
+ ## How to build in watch mode
41
+
42
+ In order to detect changes in the ` content ` directory and rebuild automatically the docs, run the following sentence:
43
+
44
+ ``` bash
45
+ npm run dev
46
+ ```
You can’t perform that action at this time.
0 commit comments