docs: scriptName

loqusion · Jan 2, 2024 · 9206739 · 9206739
1 parent e3055b4
commit 9206739
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/docs/api/derivations/build-local-typst-project.md b/docs/api/derivations/build-local-typst-project.md
@@ -48,6 +48,12 @@ All parameters accepted by
 {{#include common/local-paths-example.md:buildlocaltypstproject_example}}
 {{#include common/local-paths-example.md:tail}}
 
+### `scriptName` (optional) { #scriptname }
+
+{{#include common/script-name.md}}
+
+Default is `typst-build`.
+
 ### `typstCompileCommand` (optional) { #typstcompilecommand }
 
 {{#include common/typst-compile-command.md}}

diff --git a/docs/api/derivations/common/script-name.md b/docs/api/derivations/common/script-name.md
@@ -0,0 +1,2 @@
+Name of the script that will be added to the Nix store. You can use this name
+after entering a development shell to invoke the script.
diff --git a/docs/api/derivations/watch-typst-project.md b/docs/api/derivations/watch-typst-project.md
@@ -46,6 +46,12 @@ directory, unless you set [`forceLocalPaths`](#forcelocalpaths) to `true`.
 {{#include common/local-paths-example.md:watchtypstproject_example}}
 {{#include common/local-paths-example.md:tail}}
 
+### `scriptName` (optional) { #scriptname }
+
+{{#include common/script-name.md}}
+
+Default is `typst-watch`.
+
 ### `typstOpts` (optional) { #typstopts }
 
 {{#include common/typst-opts.md:head}}