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
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,18 +12,20 @@ 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 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
17
+
Assuming two sibling folders:
19
18
20
-
```
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
23
-
gulp build-docs
24
-
```
19
+
1. UI folder ./ui
20
+
2. Docs folder ./docs
25
21
26
-
> The default location for ``build-docs`` is an adjacent folder with the name ``docs/``. The command must be run from your UI folder and not from the docs folder.
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
27
29
28
30
To configure a different docs location modify [ tasks/docs.json](https://github.com/Semantic-Org/Semantic-UI/blob/master/tasks/admin/docs.json)
0 commit comments