Skip to content

Commit d7dcd14

Browse files
committed
Re-enable HTML inside markdown but convert most of the HTML tables into Markdown syntax to enable auto linking; finally regen updated content using 'hugo' command
1 parent d0cf0d8 commit d7dcd14

26 files changed

+122
-200
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,6 @@ library's folder.
4141

4242
Alternatively you can use docker:
4343

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

config.toml

+5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ pygmentsCodefences = true
66
pygmentsStyle = "dracula"
77
googleAnalytics = "UA-139969899-1"
88

9+
[markup.goldmark.renderer]
10+
# this setting is required to allow hugo and its Markdown renderer to process
11+
# embedded HTML tags:
12+
unsafe = true
13+
914
[permalinks]
1015
docs = "/:title"
1116

content/docs/examples/c/czmq/download.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To use the draft APIs, you may build `czmq` with `draft` feature:
4949
vcpkg install czmq[draft]
5050
```
5151

52-
If you are an adventurer, and want to always use the lastest version of `czmq`, pass an extra `--head` option:
52+
If you are an adventurer, and want to always use the latest version of `czmq`, pass an extra `--head` option:
5353
```
5454
vcpkg.exe install czmq --head
5555
```

content/docs/examples/erlang/chumak/download.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ library: chumak
1010

1111
You can install `chumak` from [hex.pm](https://hex.pm/packages/chumak) by including the following in your `rebar.config`:
1212

13-
```
13+
```erlang
1414
{deps,[
1515
{chumak, "X.Y.Z"}
1616
]}.

content/docs/examples/go/zmq4/download.md

+10
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ $ go env CGO_ENABLED
2727

2828
You can't do cross-compilation. That would disable C.
2929

30+
### Windows
31+
32+
Build with `CGO_CFLAGS` and `CGO_LDFLAGS` environment variables, for example:
33+
34+
```
35+
$env:CGO_CFLAGS='-ID:/dev/vcpkg/installed/x64-windows/include'
36+
$env:CGO_LDFLAGS='-LD:/dev/vcpkg/installed/x64-windows/lib -l:libzmq-mt-4_3_4.lib'
37+
```
38+
> Deploy result program with `libzmq-mt-4_3_4.dll`
39+
3040
## Install
3141

3242
go get github.com/pebbe/zmq4

content/docs/examples/java/jeromq/download.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ Add it to your Maven project's `pom.xml`:
1616
<dependency>
1717
<groupId>org.zeromq</groupId>
1818
<artifactId>jeromq</artifactId>
19-
<version>0.5.1</version>
19+
<version>0.5.3</version>
2020
</dependency>
2121

2222
<!-- for the latest SNAPSHOT -->
2323
<dependency>
2424
<groupId>org.zeromq</groupId>
2525
<artifactId>jeromq</artifactId>
26-
<version>0.5.2-SNAPSHOT</version>
26+
<version>0.6.0-SNAPSHOT</version>
2727
</dependency>
2828

2929
<!-- If you can't find the latest snapshot -->

content/docs/examples/nodejs/zeromqjs/download.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,24 @@ language: nodejs
66
library: zeromqjs
77
---
88

9-
# Installation
9+
## Installation
1010

11-
Install ZeroMQ.js with prebuilt binaries:
11+
Install **ZeroMQ.js** with prebuilt binaries:
1212

1313
```sh
14-
npm install [email protected].6
14+
npm install [email protected].17
1515
```
1616

17-
Requirements for prebuilt binaries:
17+
Requirements for using prebuilt binaries:
1818

1919
* Node.js 10.2+ or Electron 3+ (requires a [N-API](https://nodejs.org/api/n-api.html) version 3+)
2020

2121

22-
## Prebuilt binaries
22+
### Prebuilt binaries
2323

2424
The following platforms have a **prebuilt binary** available:
2525

26-
* Linux on x86-64/armv7/armv8 with libstdc++.so.6.0.21+ (glibc++ 3.4.21+), for example:
26+
* Linux on x86-64 with libstdc++.so.6.0.21+ (glibc++ 3.4.21+), for example:
2727
* Debian 9+ (Stretch or later)
2828
* Ubuntu 16.04+ (Xenial or later)
2929
* CentOS 8+
@@ -34,33 +34,34 @@ The following platforms have a **prebuilt binary** available:
3434

3535
If a prebuilt binary is not available for your platform, installing will attempt to start a build from source.
3636

37-
## Building from source
37+
### Building from source
3838

3939
If a prebuilt binary is unavailable or if you want to pass certain options during build, you can build this package from source.
4040

4141
Make sure you have the following installed before attempting to build from source:
4242

4343
* Node.js 10+ or Electron 3+
4444
* A working C++17 compiler toolchain with make
45-
* Python 2.7 (or Python 3 with Node 12.13+)
45+
* Python 3 with Node 12.13+ (or legacy Python 2.7)
4646
* CMake 2.8+
4747
* curl
4848

49-
To install from source
49+
To install from source:
5050

5151
```sh
52-
npm install [email protected].6 --build-from-source
52+
npm install [email protected].17 --build-from-source
5353
```
5454

55-
If you want to link against a shared ZeroMQ library, you can build skip downloading libzmq and link with the installed library instead as follows:
55+
If you want to link against a shared ZeroMQ library, you can build skip downloading `libzmq` and link with the
56+
installed library instead as follows:
5657

5758
```sh
58-
npm install [email protected].6 --zmq-shared
59+
npm install [email protected].17 --zmq-shared
5960
```
6061

6162
If you wish to use any DRAFT sockets then it is also necessary to compile the library from source:
6263

6364
```sh
64-
npm install [email protected].6 --zmq-draft
65+
npm install [email protected].17 --zmq-draft
6566
```
6667

content/docs/examples/python/pyzmq/download.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ library: pyzmq
1010

1111
Unless you specifically want to develop PyZMQ, we recommend downloading
1212
the PyZMQ source code or wheels from
13-
[PyPI](https://pypi.io/project/pyzmq),
13+
[PyPI](https://pypi.io/project/pyzmq/),
1414
or install with conda.
1515

1616
You can also get the latest source code from our GitHub repository, but
@@ -20,30 +20,36 @@ building from the repository will require that you install recent Cython.
2020

2121
For more detail on building pyzmq, see [our Wiki](https://github.com/zeromq/pyzmq/wiki/Building-and-Installing-PyZMQ).
2222

23-
We build wheels for OS X, Windows, and Linux, so you can get a binary on those platforms with:
23+
We build wheels for macOS, Windows, and Linux, so you can get a binary on those platforms with:
2424

25+
```
2526
pip install pyzmq
27+
```
2628

2729
but compiling from source with `pip install pyzmq` should work in most environments.
28-
Especially on OS X, make sure you are using the latest pip (≥ 8), or it may not find the right wheels.
30+
Especially on macOS, make sure you are using the latest pip (≥ 8), or it may not find the right wheels.
2931

3032
If the wheel doesn't work for some reason, or you want to force pyzmq to be compiled
3133
(this is often preferable if you already have libzmq installed and configured the way you want it),
3234
you can force installation with:
3335

36+
```
3437
pip install --no-binary=:all: pyzmq
38+
```
3539

3640
When compiling pyzmq (e.g. installing with pip on Linux),
3741
it is generally recommended that zeromq be installed separately,
3842
via homebrew, apt, yum, etc:
3943

44+
```
4045
# Debian-based
4146
sudo apt-get install libzmq3-dev
4247
4348
# RHEL-based
4449
sudo yum install libzmq3-devel
50+
```
4551

46-
If this is not available, pyzmq will *try* to build libzmq as a Python Extension,
52+
If this is not available, pyzmq will _try_ to build libzmq as a Python Extension,
4753
though this is not guaranteed to work.
4854

4955
Building pyzmq from the git repo (including release tags on GitHub) requires Cython.

content/docs/examples/rust/rust-zmq/download.md

-81
Original file line numberDiff line numberDiff line change
@@ -6,84 +6,3 @@ language: rust
66
library: rust-zmq
77
---
88

9-
# Installation
10-
11-
rust-zmq is available from [crates.io](https://crates.io). Users
12-
should add this to their `Cargo.toml` file:
13-
14-
```toml
15-
[dependencies]
16-
zmq = "0.9"
17-
```
18-
19-
As rust-zmq is a wrapper around `libzmq`, you need a build of `libzmq`
20-
version 4.1 or newer, before attempting to build the `zmq`
21-
crate. There are several options available:
22-
23-
## Dynamic linking using `pkg-config`
24-
25-
This is probably the preferred method when you are running a recent
26-
Unix-like OS that has support for `pkg-config`. For example, on recent
27-
Debian-based distributions, you can use the following command to get
28-
the prerequiste headers and library installed:
29-
30-
```sh
31-
apt install libzmq3-dev
32-
```
33-
34-
If your OS of choice does not provide packages of a new-enough libzmq,
35-
you can install it from source; see
36-
<https://github.com/zeromq/libzmq/releases>, although in this case,
37-
you may prefer a `vendored` build, which automates that, see below.
38-
39-
The build normally uses `pkg-config` to find out about libzmq's
40-
location. If that is not available, the environment variable
41-
`LIBZMQ_PREFIX` (or alternatively, `LIBZMQ_LIB_DIR` and
42-
`LIBZMQ_INCLUDE_DIR`) can be defined to avoid the invocation of
43-
`pkg-config`.
44-
45-
## Windows build
46-
47-
When building on Windows, using the MSCV toolchain, consider the
48-
following when trying to link dynamically against `libzmq`:
49-
50-
- When building `libzmq` from sources, the library must be renamed
51-
to `zmq.lib` from the auto named `libzmq-v***-mt-gd-*_*_*.lib`,
52-
`libzmq.lib`, `libzmq-mt-*_*_*.lib`, etc.
53-
- The folder containing the `*.dll` (dynamic link library)
54-
referred to by `zmq.lib` must be accessible via the path for
55-
the session that invokes the Rust compiler.
56-
- The name of the `*.dll` in question depends on the build system
57-
used for `libzmq` and can usually be seen when opening `zmq.lib`
58-
in a text editor.
59-
60-
## Vendored build
61-
62-
Starting with the upcoming release `0.9.1` (or when building from
63-
current `master`), you can enable the `vendored` feature flag to have
64-
`libzmq` be built for you and statically linked into your binary
65-
crate. In your `Cargo.toml`, you can give users the option to do so
66-
using a dedicated feature flag:
67-
68-
```toml
69-
[features]
70-
vendored-zmq = ['zmq/vendored']
71-
```
72-
73-
## Cross-compilation
74-
75-
When you have a cross-compiled version of `libzmq` installed, you
76-
should be able to cross-compile rust-zmq, assuming a platform
77-
supporting `pkg-config`. For example, assuming you have `libzmq`
78-
compiled for the `i686-pc-windows-gnu` target installed in
79-
`~/.local-w32`, the following should work:
80-
81-
```sh
82-
PKG_CONFIG_PATH=$HOME/.local-w32/lib/pkgconfig \
83-
PKG_CONFIG_ALLOW_CROSS=1 \
84-
cargo build --target=i686-pc-windows-gnu --verbose
85-
```
86-
87-
Cross compilation without `pkg-config` should work as well, but you
88-
need set `LIBZMQ_PREFIX` as described above.
89-

content/languages/c.md

+6-22
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,10 @@ The recommended binding for C developers is CZMQ, which provides a high-level AP
1010

1111
## CZMQ
1212

13-
<table>
14-
<tr><td>Github</td><td>
15-
16-
[https://github.com/zeromq/czmq](https://github.com/zeromq/czmq)
13+
| Github | https://github.com/zeromq/czmq |
14+
|--------|--------------------------------|
15+
| Docs | http://czmq.zeromq.org/ |
1716

18-
</td></tr>
19-
<tr><td>Docs</td><td>
20-
21-
[http://czmq.zeromq.org/](http://czmq.zeromq.org/)
22-
23-
</td></tr>
24-
</table>
2517

2618
### Install
2719

@@ -89,18 +81,10 @@ int main (void)
8981
9082
## libzmq
9183
92-
<table>
93-
<tr><td>Github</td><td>
94-
95-
[https://github.com/zeromq/libzmq](https://github.com/zeromq/libzmq)
96-
97-
</td></tr>
98-
<tr><td>Docs</td><td>
99-
100-
[http://api.zeromq.org/](http://api.zeromq.org/)
84+
| Github | https://github.com/zeromq/libzmq |
85+
|--------|----------------------------------|
86+
| Docs | http://api.zeromq.org/ |
10187
102-
</td></tr>
103-
</table>
10488
10589
### Install
10690

content/languages/cplusplus.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ toc: true
66

77
## cppzmq
88

9-
<table>
10-
<tr><td>Github</td><td><a href="https://github.com/zeromq/cppzmq">https://github.com/zeromq/cppzmq</a></td></tr>
11-
</table>
9+
| Github | https://github.com/zeromq/cppzmq |
10+
|--------|----------------------------------|
1211

1312
Header-only C++ binding for libzmq.
1413

content/languages/csharp.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ NetMQ is the recommended option, which has implemented curve encryption (https:/
99

1010
## NetMQ
1111

12-
<table>
13-
<tr><td>Github</td><td><a href="https://github.com/zeromq/netmq" target="_blank">https://github.com/zeromq/netmq</a></td></tr>
14-
<tr><td>Docs</td><td><a href="https://netmq.readthedocs.io/en/latest/" target="_blank">https://netmq.readthedocs.io/en/latest/</a></td></tr>
15-
<tr><td>Nuget</td><td><a href="https://www.nuget.org/packages/NetMQ" target="_blank">https://www.nuget.org/packages/NetMQ</a></td></tr>
16-
</table>
12+
| Github | https://github.com/zeromq/netmq |
13+
|--------|-----------------------------------------|
14+
| Docs | https://netmq.readthedocs.io/en/latest/ |
15+
| Nuget | https://www.nuget.org/packages/NetMQ |
16+
1717

1818
### Request-Response
1919

content/languages/dart.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: Dart
33
weight: 4
44
---
55

6-
<table>
7-
<tr><td>Github</td><td>https://github.com/enwi/dartzmq</td></tr>
8-
<tr><td>pub.dev</td><td>https://pub.dev/packages/dartzmq</td></tr>
9-
<tr><td>Examples</td><td>https://github.com/enwi/dartzmq/tree/main/example</td></tr>
10-
</table>
6+
| Github | https://github.com/enwi/dartzmq |
7+
|----------|---------------------------------------------------|
8+
| pub.dev | https://pub.dev/packages/dartzmq |
9+
| Examples | https://github.com/enwi/dartzmq/tree/main/example |
10+
1111

1212
## Installation
1313

content/languages/erlang.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ toc: true
66

77
## erlzmq_dnif
88

9-
<table>
10-
<tr><td>Github</td><td>http://github.com/lukaszsamson/erlzmq</td></tr>
11-
<tr><td>Hex</td><td>https://hex.pm/packages/erlzmq_dnif</td></tr>
12-
</table>
9+
| Github | http://github.com/lukaszsamson/erlzmq |
10+
|--------|---------------------------------------|
11+
| Hex | https://hex.pm/packages/erlzmq_dnif |
12+
1313

1414
Fork of erlzmq2 using dirty NIFs for blocking IO calls and dedicated threads for safely handling sockets.
1515
Compatible with zmq 4.x

content/languages/fsharp.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Two alternatives are available for F# developers, `fszmq` and `FsNetMQ`. `fszmq`
99

1010
## FsNetMQ
1111

12-
<table>
13-
<tr><td>Github</td><td>https://github.com/NetMQ/FsNetMQ</td></tr>
14-
<tr><td>Nuget</td><td>https://www.nuget.org/packages/FsNetMQ/</td></tr>
15-
</table>
12+
| Github | https://github.com/NetMQ/FsNetMQ |
13+
|--------|-----------------------------------------|
14+
| Nuget | https://www.nuget.org/packages/FsNetMQ/ |
15+
1616

1717
### Example
1818

0 commit comments

Comments
 (0)