mirror of
https://github.com/Orange-OpenSource/hurl.git
synced 2024-09-11 05:35:53 +03:00
.. | ||
assets/img | ||
man | ||
spec | ||
tutorial | ||
asserting-response.md | ||
capturing-response.md | ||
entry.md | ||
frequently-asked-questions.md | ||
grammar.md | ||
home.md | ||
hurl-file.md | ||
index.md | ||
installation.md | ||
license.md | ||
man-page.md | ||
README.md | ||
request.md | ||
response.md | ||
running-tests.md | ||
samples.md | ||
templates.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 :
- to generate man pages
hurl.1
andhurlfmt.1
- to generate Markdown documentation page
man-page.md
for https://hurl.dev
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