From 8c3246c64a8ff42ee68d6081d9f3c86ccaf1de55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20M=C3=BCller?= Date: Wed, 15 Apr 2020 02:31:27 +0200 Subject: [PATCH] Add project info options for crystal docs --- using_the_compiler/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/using_the_compiler/README.md b/using_the_compiler/README.md index 27f6b9dbc..c43b1a220 100644 --- a/using_the_compiler/README.md +++ b/using_the_compiler/README.md @@ -254,6 +254,8 @@ crystal docs src/my_app.cr **Common options:** +* `--project-name=NAME`: Set the project name. The default value is extracted from `shard.yml` if available. In case no default can be found, this option is mandatory. +* `--project-version=VERSION`: Set the project version. The default value is extracted from current git commit or `shard.yml` if available. In case no default can be found, this option is mandatory. * `--output=DIR, -o DIR`: Set the output directory (default: `./docs`) * `--canonical-base-url=URL, -b URL`: Set the [canonical base url](https://en.wikipedia.org/wiki/Canonical_link_element)