Skip to content

Commit b1a7964

Browse files
committed
Indication of when and where
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.
1 parent d8e56e4 commit b1a7964

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@ docpad update; docpad upgrade;
1515
### Generating SUI for Docs
1616

1717
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
1819

1920
```
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
2123
gulp build-docs
2224
```
2325

@@ -30,6 +32,7 @@ To configure a different docs location modify [ tasks/docs.json](https://github.
3032

3133
You can then start your docs server (and generate docs) using:
3234
```
35+
#run from inside docs folder that will now contain the compiled docs - windows users can then navigate to http://localhost:9778
3336
docpad run
3437
```
3538

0 commit comments

Comments
 (0)