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
+13-30Lines changed: 13 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,46 +12,29 @@ docpad install eco;
12
12
docpad update; docpad upgrade;
13
13
```
14
14
15
-
### Generating SUI for Docs
15
+
### Generating Semantic UI for Docs
16
16
17
-
Before running the server, you will need to build your UI files for the docs.
17
+
Assuming two sibling folders:
18
18
19
-
First, be sure your docs are in the right location.
20
-
For example, if your Semantic UI folder is under `vendor/`, like this...
19
+
1. UI folder ./ui
20
+
2. Docs folder ./docs
21
21
22
-
vendor/
23
-
SemanticUI/
24
-
...
25
-
...
26
-
27
-
Then you should put `docs/` under `vendor/`, so it looks like this:
28
-
29
-
vendor/
30
-
docs/
31
-
SemanticUI/
32
-
...
33
-
...
34
-
35
-
If you haven't run `npm install` in your `./SemanticUI` folder yet, do that now. Next, run the commands to build the docs:
36
-
37
-
```
38
-
# "ui" can be any folder that contains the SUI build files
39
-
cd ./ui
40
-
gulp build-docs
41
-
```
42
-
43
-
By default, docs build to `build-docs/` (from the adjacent folder `docs/`).
44
-
**The command _must_ be run from your UI folder!** (In the above example, we use `./ui`.)
45
-
46
-
To configure a different `docs` location, modify [`tasks/config/docs.js`](https://github.com/Semantic-Org/Semantic-UI/blob/master/tasks/config/docs.js) accordingly.
22
+
* Clone both repos to respective folders
23
+
* npm install in both directories
24
+
* Go through Semantic UI installer steps (auto)
25
+
* In ./ui folder `gulp build-docs` (builds files to ./docs)
26
+
* In ./docs folder `docpad run`
27
+
* Go to http://localhost:9778/ docs should be there
28
+
* Optionally run `gulp serve-docs` in ./ui to serve any changes from ./ui/src to ./docs
29
+
>>>>>>> 3264be9f53cc7bfd2db466a4ab0ec5488d557991
47
30
48
31
49
32
### Running the Server
50
33
51
34
Start the docs server (and generate docs):
52
35
53
36
```
54
-
# run from inside docs folder that will now contain the compiled docs
37
+
# run from inside docs folder that will now contain the compiled docs
55
38
# windows users can then navigate to http://localhost:9778
0 commit comments