mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-11-22 15:42:20 +03:00

History

Fabrice Reix b912a6f06c Add url query		2022-10-16 09:59:08 +02:00
..
assets/img	Clean image docs.	2022-10-11 13:14:16 +02:00
manual	Delete --progress and --summary from docs.	2022-09-30 18:01:20 +02:00
spec	Add url query	2022-10-16 09:59:08 +02:00
tutorial	Fix typos	2022-10-01 18:48:18 +08:00
asserting-response.md	Update header docs when a same header has multiple values.	2022-10-11 21:56:36 +02:00
capturing-response.md	fix grammar in docs	2022-09-28 18:35:02 +10:00
entry.md	fix grammar in docs	2022-09-28 18:35:02 +10:00
frequently-asked-questions.md	fix typos in docs	2022-09-28 18:35:02 +10:00
grammar.md	Add support for strings comparison.	2022-09-09 16:54:28 +02:00
home.md	Add Demo placeholder.	2022-10-10 17:50:58 +02:00
hurl-file.md	fix grammar in docs	2022-09-28 18:35:02 +10:00
index.md	Rename manual-page.md to manual.md	2022-09-02 15:39:24 +02:00
installation.md	Update macOS binary installations.	2022-10-10 17:27:06 +02:00
license.md	Add licence.md in docs.	2022-06-05 17:33:06 +02:00
manual.md	Delete --progress and --summary from docs.	2022-09-30 18:01:20 +02:00
README.md	Rename manual-page.md to manual.md	2022-09-02 15:39:24 +02:00
request.md	fix grammar in docs	2022-09-28 18:35:02 +10:00
response.md	fix grammar in docs	2022-09-28 18:35:02 +10:00
running-tests.md	fix grammar in docs	2022-09-28 18:35:02 +10:00
samples.md	change "api" to "API" in docs	2022-09-28 18:35:02 +10:00
templates.md	fix grammar in docs	2022-09-28 18:35:02 +10:00

README.md

Hurl Documentation

This directory is the canonical source for Hurl documentation. The site https://hurl.dev, powered by Jekyll, is generated from it. If you want to modify https://hurl.dev, you can make a PR in this repo.

Manual Page

The canonical source for the Hurl manual pages is at https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual. The markdown files hurl.md and hurlfmt.md are used :

to generate manual pages hurl.1 and hurlfmt.1
to generate Markdown documentation page manual.md for https://hurl.dev

Dependencies:

docs/manual/hurl.md => docs/manual/hurl.1
docs/manual/hurl.md => docs/manual.md

docs/manual/hurlfmt.md => docs/manual/hurlfmt.1

READMEs

GitHub README and crates.io README are generated from the canonical docs.

Dependencies:

docs/*.md => README.md
docs/*.md => packages/hurl/README.md

Scripts

generate manual
generate <hurl.dev> manual
generate GitHub README
generate crates.io README

$ python3 bin/release/gen_manpage.py docs/manual/hurl.md > docs/manual/hurl.1
$ python3 bin/release/gen_manpage.py docs/manual/hurlfmt.md > docs/manual/hurlfmt.1
$ python3 bin/docs/build_man_md.py docs/manual/hurl.md > docs/manual.md
$ python3 bin/docs/build_readme.py github > README.md
$ python3 bin/docs/build_readme.py crates > packages/hurl/README.md