Skip to content

Commit 857e795

Browse files
committed
Merge branch 'patch-1' of https://github.com/kevlened/Semantic-UI-Docs into next
2 parents d877b5f + 3264be9 commit 857e795

1 file changed

Lines changed: 13 additions & 30 deletions

File tree

README.md

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,46 +12,29 @@ docpad install eco;
1212
docpad update; docpad upgrade;
1313
```
1414

15-
### Generating SUI for Docs
15+
### Generating Semantic UI for Docs
1616

17-
Before running the server, you will need to build your UI files for the docs.
17+
Assuming two sibling folders:
1818

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
2121

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
4730
4831

4932
### Running the Server
5033

5134
Start the docs server (and generate docs):
5235

5336
```
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
5538
# windows users can then navigate to http://localhost:9778
5639
docpad run
5740
```

0 commit comments

Comments
 (0)