Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-09-11 05:35:53 +03:00
Code Issues Packages Projects Releases Wiki Activity
08fc128a9b
hurl/docs
History
jcamiel 08fc128a9b
Update man and README.
2022-08-16 13:39:13 +02:00
..
assets/img Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
man Update man and README. 2022-08-16 13:39:13 +02:00
spec Add max-redirs entry option. 2022-08-16 12:09:33 +02:00
tutorial Emphasize --test mode in tutorial. 2022-06-11 16:27:12 +02:00
asserting-response.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
capturing-response.md Remove duplicate line in snippet. 2022-06-06 22:29:40 +02:00
entry.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
frequently-asked-questions.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
grammar.md Delete legacy grammar. 2022-06-20 19:16:57 +02:00
home.md Update READMEs 2022-06-13 09:04:29 +02:00
hurl-file.md Fix typo: somment --> comment 2022-06-23 20:24:27 +02:00
index.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
installation.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
license.md Add licence.md in docs. 2022-06-05 17:33:06 +02:00
man-page.md Update man and README. 2022-08-16 13:39:13 +02:00
README.md Update man and README. 2022-08-16 13:39:13 +02:00
request.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
response.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
running-tests.md Emphasize --test mode in tutorial. 2022-06-11 16:27:12 +02:00
samples.md Emphasize --test mode in tutorial. 2022-06-11 16:27:12 +02:00
templates.md Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02: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 make modifications to https://hurl.dev, you can make a PR in this repo.

Man Page

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

docs/man/hurl.md => docs/man/hurl.1
docs/man/hurl.md => docs/man-page.md

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

READMEs

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

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