Websites
/
lektor-website
mirror of https://github.com/lektor/lektor-website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(cls): updates for lektor/lektor#1120 

Note that --output-path is (now) interpreted relative to the current
working directory.
This commit is contained in:
Jeff Dairiki 2023-03-11 12:47:16 -08:00
parent 8e2b686ec2
commit 3e1fab4f16
4 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
content/docs/cli/build/contents.lr
View File

@ -30,6 +30,8 @@ used by external scripts to only deploy on successful build for instance.
## Options ## Options
- `-O, --output-path PATH`: The output path. - `-O, --output-path PATH`: The output path.
This overrides any `output_path` setting in the [project file :ref](http://localhost:5000/docs/project/file/#project).
A relative path is interpreted relative to the *current working directory*.
- `--watch`: If this is enabled the build process goes into an automatic - `--watch`: If this is enabled the build process goes into an automatic
loop where it watches the file system for changes and rebuilds. loop where it watches the file system for changes and rebuilds.
- `--prune / --no-prune`: Controls if old artifacts should be pruned. - `--prune / --no-prune`: Controls if old artifacts should be pruned.
@ -42,4 +44,4 @@ used by external scripts to only deploy on successful build for instance.
used by plugins to customize the build process. More information can be used by plugins to customize the build process. More information can be
found in the documentation of affected plugins. found in the documentation of affected plugins.
- `--profile`: Enable build profiler. - `--profile`: Enable build profiler.
- `--help`: print this help page. - `--help`: print this help page.

4
content/docs/cli/clean/contents.lr
View File

@ -18,6 +18,8 @@ in the Lektor cache is used.
## Options ## Options
- `-O, --output-path PATH`: The output path. - `-O, --output-path PATH`: The output path.
This overrides any `output_path` setting in the [project file :ref](http://localhost:5000/docs/project/file/#project).
A relative path is interpreted relative to the *current working directory*.
- `-v, --verbose`: Increases the verbosity of the logging. - `-v, --verbose`: Increases the verbosity of the logging.
- `--yes`: Confirms the cleaning. - `--yes`: Confirms the cleaning.
- `--help`: print this help page. - `--help`: print this help page.

4
content/docs/cli/deploy/contents.lr
View File

@ -27,6 +27,8 @@ For more information see the deployment chapter in the documentation.
## Options ## Options
- `-O, --output-path PATH`: The output path. - `-O, --output-path PATH`: The output path.
This overrides any `output_path` setting in the [project file :ref](http://localhost:5000/docs/project/file/#project).
A relative path is interpreted relative to the *current working directory*.
- `--username TEXT`: An optional username to override the URL. - `--username TEXT`: An optional username to override the URL.
- `--password TEXT`: An optional password to override the URL or the - `--password TEXT`: An optional password to override the URL or the
default prompt. default prompt.
@ -34,4 +36,4 @@ For more information see the deployment chapter in the documentation.
authentication of the deployment. authentication of the deployment.
- `--key TEXT`: The contents of a key file directly a string that should - `--key TEXT`: The contents of a key file directly a string that should
be used for authentication of the deployment. be used for authentication of the deployment.
- `--help`: print this help page. - `--help`: print this help page.

6
content/docs/cli/server/contents.lr
View File

@ -25,8 +25,12 @@ HTTP server.
- `-p, --port INTEGER`: The port to bind to. - `-p, --port INTEGER`: The port to bind to.
- `-O, --output-path PATH`: The dev server will build into the same folder - `-O, --output-path PATH`: The dev server will build into the same folder
as the build command by default. as the build command by default.
- `-O, --output-path PATH`: The output path.
Note that, by default, the dev server will build into the same folder as the build command.
This overrides any `output_path` setting in the [project file :ref](http://localhost:5000/docs/project/file/#project).
A relative path is interpreted relative to the *current working directory*.
- `-v, --verbose`: Increases the verbosity of the logging. - `-v, --verbose`: Increases the verbosity of the logging.
- `-f, --build-flag TEXT`: Defines an arbitrary build flag. These can be - `-f, --build-flag TEXT`: Defines an arbitrary build flag. These can be
used by plugins to customize the build process. More information can be used by plugins to customize the build process. More information can be
found in the documentation of affected plugins. found in the documentation of affected plugins.
- `--help`: print this help page. - `--help`: print this help page.