Skip to content

Commit

Permalink
fixed typos in USAGE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sudarshan-21 authored Mar 25, 2024
1 parent 28b18e5 commit a1529d3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ Docker

- Clone the kolibri2zim repository to your local machine

- run the following command with the channel id and `name-of-the-zim` you are converting to to .zim, `channel-id` is a 32-characters long ID that you can find in the URL of the channel you want, either from [Kolibri Studio](https://studio.learningequality.org) or the [Kolibri Catalog](https://kolibri-catalog-en.learningequality.org)
- run the following command with the channel id and `name-of-the-zim` you are converting to .zim, `channel-id` is a 32-characters long ID that you can find in the URL of the channel you want, either from [Kolibri Studio](https://studio.learningequality.org) or the [Kolibri Catalog](https://kolibri-catalog-en.learningequality.org)

```bash
docker run -v my_dir:/output ghcr.io/openzim/kolibri kolibri2zim --channel-id `channel-id` --name `name-of-the-channel`
```

- This will create a `.zim` file in the `/output` file, which will be persisted in the my_dir Docker volume.

-For getting this .zim file on to your local machine you can save it to your desktop by using `save` command(right click on mouse).
-For getting this .zim file on to your local machine you can save it to your desktop by using `save` command.

- For opening this `.zim` file, you need a ZIM reader,you could use a Kiwix one and you might use [kiwix-serve](https://kiwix.org/en/applications/).
- For opening this `.zim` file, you need a ZIM reader, you could use a Kiwix one and you might use [kiwix-serve](https://kiwix.org/en/applications/).

- now you can access that created `.zim` file from the `kiwix-serve ui` and start the server on the localhost.

Expand Down

0 comments on commit a1529d3

Please sign in to comment.