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-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,16 +38,20 @@ First you need to fork some projects and configure them correctly to set up the
38
38
39
39
If configuration is completed you have to:
40
40
41
-
1. Clone your forked `docpad-skeleton-apidocs` repository
42
-
2. Navigate to its local clone in the terminal
41
+
1. Clone your forked `docpad-skeleton-apidocs` repository,
42
+
43
+
2. Navigate to its local clone in the terminal,
44
+
43
45
3. Call the following command: `npm start`
46
+
44
47
4. Once the start is completed, open in the browser the following link: http://localhost:9778/
45
48
46
49
## Publishing to GitHub Pages
47
50
48
51
The easiest solution is to publish the API Doc portal on GitHub pages. Of course the generated API Doc portal files can be hosted on any other server as it is pure static content.
49
52
50
53
1. Create new repository with the following name: `your_github_username.github.io`. It must be public and initialized (You do it in UI during creation).
54
+
51
55
2. Modify `chewieConfig.js` file in forked `docpad-skeleton-apidocs` repository.
52
56
- Change the `srcLocation` attribute:
53
57
```
@@ -59,6 +63,7 @@ The easiest solution is to publish the API Doc portal on GitHub pages. Of course
0 commit comments