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
+13-6Lines changed: 13 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ The Django Girls Tutorial is licensed under a [*Creative Commons Attribution-Sha
11
11
12
12
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.
13
13
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/).
15
15
16
16
The tutorial is written in [Markdown mark up language](https://help.github.com/articles/markdown-basics).
17
17
@@ -60,15 +60,24 @@ Either use the GitHub app for your operating system (mentioned above) or `git` c
Move to the folder containing the project, to run the following commands.
64
+
65
+
cd tutorial
66
+
63
67
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.
64
68
65
69
git checkout -b contributing
66
70
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
68
74
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:
70
76
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.
72
81
73
82
Then commit the changes using `git` and push the changes to your remote GitHub repository.
74
83
@@ -97,8 +106,6 @@ Example:
97
106
To git@github.com:miohtama/tutorial.git
98
107
b37ca59..fe36152 contributing -> contributing
99
108
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
-
102
109
# Making a pull request
103
110
104
111
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