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
Attempt at better indicating where files should be located and commands to be run, as I personally have trouble with picturing the appropriate directory structure and workflow when including into projects.
Copy file name to clipboardExpand all lines: README.md
+4-1
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,11 @@ docpad update; docpad upgrade;
15
15
### Generating SUI for Docs
16
16
17
17
Before running server you will need to build your UI files for the docs. Semantic UI includes a special command to build files for a docs instance that must be run from an adjacent Semantic UI folder.
18
+
for example with a directory vendor -> SemanticUI place docs folder inside vendor to reflect vendor -> SemanticUI | docs
18
19
19
20
```
20
-
# assumes ./docs and ./ui for default paths, run from ./ui
21
+
# assumes ./docs and ./ui for default paths, run from ./ui (the folder name ./ui may be any folder that contains the Semantic UI build files)
22
+
# run gulp build-docs from the folder containing Semantic UI this will build docs into the sibling folder ./docs
21
23
gulp build-docs
22
24
```
23
25
@@ -30,6 +32,7 @@ To configure a different docs location modify [ tasks/docs.json](https://github.
30
32
31
33
You can then start your docs server (and generate docs) using:
32
34
```
35
+
#run from inside docs folder that will now contain the compiled docs - windows users can then navigate to http://localhost:9778
0 commit comments