Skip to content

Commit ce7926f

Browse files
author
Gornicki, Lukasz
committed
formatting
1 parent 0749d69 commit ce7926f

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,20 @@ First you need to fork some projects and configure them correctly to set up the
3838

3939
If configuration is completed you have to:
4040

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+
4345
3. Call the following command: `npm start`
46+
4447
4. Once the start is completed, open in the browser the following link: http://localhost:9778/
4548

4649
## Publishing to GitHub Pages
4750

4851
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.
4952

5053
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+
5155
2. Modify `chewieConfig.js` file in forked `docpad-skeleton-apidocs` repository.
5256
- Change the `srcLocation` attribute:
5357
```
@@ -59,6 +63,7 @@ The easiest solution is to publish the API Doc portal on GitHub pages. Of course
5963
docuUrl: process.env.docuURL || 'http://derberg.github.io',
6064
```
6165
The page url must be the same as the name of your newly created `your_github_username.github.io` repository.
66+
6267
3. Modify `docpad.coffee` file in forked `docpad-skeleton-apidocs` repository. Change the `url` attribute:
6368
```
6469
environments:
@@ -68,7 +73,11 @@ environments:
6873
url: "http://derberg.github.io"
6974
```
7075
It should point to the following url: `http://your_github_username.github.io`
76+
7177
4. Navigate to the local clone of `docpad-skeleton-apidocs` repository in the terminal
78+
7279
5. Call the following command: `npm run production`
80+
7381
6. Call the following command: `gulp pushResult`
82+
7483
7. Once the push is completed, open in the browser the following link: http://your_github_username.github.io

0 commit comments

Comments
 (0)