Skip to content

Commit 912e031

Browse files
authored
Merge pull request #1759 from adamantike/fix/readme-honkit
Replace GitBook with HonKit in Readme file
2 parents 98bd696 + f78598e commit 912e031

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Django Girls Tutorial is licensed under a [*Creative Commons Attribution-Sha
1111

1212
The source code of the tutorial is [hosted on GitHub](https://github.com/DjangoGirls/tutorial). The GitHub [Fork & Pull workflow](https://help.github.com/articles/using-pull-requests) is used to accept and review changes.
1313

14-
The tutorial uses the [GitBook](https://legacy.gitbook.com/) service for publishing its documentation. [See more information about how GitBook works](https://help.gitbook.com/).
14+
The tutorial uses the [HonKit](https://github.com/honkit/honkit) project for publishing its documentation. [See more information about how HonKit works](https://honkit.netlify.app/).
1515

1616
The tutorial is written in [Markdown mark up language](https://help.github.com/articles/markdown-basics).
1717

@@ -60,15 +60,24 @@ Either use the GitHub app for your operating system (mentioned above) or `git` c
6060

6161
git clone git@github.com:yourgithubusername/tutorial.git
6262

63+
Move to the folder containing the project, to run the following commands.
64+
65+
cd tutorial
66+
6367
Then, create a branch for your new changes to sit in. It helps to call the branch something related to the changes you are going to make.
6468

6569
git checkout -b contributing
6670

67-
Download the [GitBook Editor](https://legacy.gitbook.com/editor) app to your computer.
71+
Install the project's requirements using [`npm`](https://docs.npmjs.com/cli/v8/configuring-npm/install).
72+
73+
npm install
6874

69-
Then you can open the tutorial in GitBook Editor (*File* > *Open book*).
75+
To preview and serve local files, with auto-reload capabilities, run HonKit using:
7076

71-
Make any changes in the tutorial using GitBook and then save changes (*Book* > *Save all*).
77+
npx honkit serve
78+
79+
The local server will be available at http://localhost:4000.
80+
If auto-reload is slow, you can temporarily remove unwanted languages from `LANGS.md`, to speed up the process.
7281

7382
Then commit the changes using `git` and push the changes to your remote GitHub repository.
7483

@@ -97,8 +106,6 @@ Example:
97106
To git@github.com:miohtama/tutorial.git
98107
b37ca59..fe36152 contributing -> contributing
99108

100-
If you don't want to download the GitBook Editor app you can also go to the [GitBook website](https://legacy.gitbook.com/), sign up for free and work directly in your browser.
101-
102109
# Making a pull request
103110

104111
After you have finished your changes you need to create [a pull request](https://help.github.com/articles/using-pull-requests) on GitHub. DjangoGirls will get notified about the pull request, review your changes, suggest any corrections if needed and then *pull* your changes to the master version.

0 commit comments

Comments
 (0)