The official documentation site for Hurl.
This repo contains only the documentation and tutorials for Hurl. If you're looking for Hurl source code, please check out https://github.com/Orange-OpenSource/hurl. Please note that the canonical sources for the documentation are on the Hurl repository. This repo uses this doc to build a Jekyll powered documentation site, so it can be seen as a read-only view on the canonical docs.
Edits on documentation are done via pull request in the Hurl repository. All docs files are under docs/
repository,
in Markdown. Once a pull request is accepted, modifications are automatically published
to https://hurl.dev via the publish GitHub action.
- Jekyll
- Python 3, with Beautiful Soup 4 package (
bs4
)
$ cd sites
$ ./build.sh
$ cd sites
$ python3 -m http.server --dir hurl.dev/_site 4000
$ cd sites
$ jekyll serve --source hurl.dev --destination hurl.dev/_site
When running with Jekyll, the local built is rerun automatically for each modification. In this mode, Hurl code snippets haven't any syntax coloring.
build.sh
: uber-script to build <hurl.dev> from scratchbuild_anchors.py
: add anchors to every HTML tag. Exemple:<h2 id="some-stuff">Some Title</h2>
becomes<h2 id="some-stuff"><a href="#some-stuff">Some Title</a></h2>
build_index.py
: construct search index (search is entirely done viz Javascript in the browser, without any server apis.)build_sitemap.py
: generate https://hurl.dev/sitemap.txtdeploy.sh
: deploy a local build to https://hurl.devhighlight.py
: generate syntax coloring for Hurl snippets- others: utilities