An open API service indexing awesome lists of open source software.

https://github.com/zeromq/zeromq.org

ZeroMQ Website
https://github.com/zeromq/zeromq.org

Last synced: 6 months ago
JSON representation

ZeroMQ Website

Awesome Lists containing this project

README

          

# ZeroMQ Website

Website is generated using [hugo](https://gohugo.io/), a static website engine
and hosted via [netlify](https://www.netlify.com/).

You can check it out at https://zeromq.org

## Contribute

### Language Pages

Help is needed with the different language pages
https://github.com/zeromq/zeromq.org/tree/master/content/languages.

Please pick one of them and provide:

1. Links to `GitHub`, docs and package manager
2. Download instructions
3. Example

### Documentation Examples

Help is as well needed to translate the examples for different programming
languages and libraries in the documentation.

If you're translating from scratch you the hugo archetype which will create a
stub for each example.

```sh
hugo new --kind examples docs/examples//
```

If you're like to add an example copy an existing on from
`content/docs/examples/c/libzmq/.md` to your language's and
library's folder.

## Run locally

1. Run `npm install` to install CSS and JavaScript dependencies
2. Run `make serve` to compile the website and start the local server on port 1313

Alternatively you can use docker:

1. Run `npm install` to install CSS and JavaScript dependencies
1. Run `make docker-build`
2. Run `make docker-run` to start a local server on port 80