Skip to content

Commit

Permalink
Update examples for CLI Commands in UG (#2247)
Browse files Browse the repository at this point in the history
  • Loading branch information
lhw-1 committed Mar 30, 2023
1 parent c16cc59 commit c5263ba
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions docs/userGuide/cliCommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ The caveat is that not building all pages during the initial process, or not reb


{{ icon_examples }}
* `markbind serve`
* `markbind serve ./myWebsite`
* `markbind serve -p 8888 -s otherSite.json`
* `markbind serve` : Serves the site from the current working directory.
* `markbind serve ./myWebsite` : Serves the site from the `./myWebsite` directory.
* `markbind serve -p 8888 -s otherSite.json` : Serves the site in Port 8888 from the current working directory, using `otherSite.json` as the site configuration file.

</panel>

Expand Down Expand Up @@ -153,19 +153,18 @@ The caveat is that not building all pages during the initial process, or not reb
**Options** :fas-cogs:

* `--baseUrl <base>`<br>
Override the `baseUrl` property (read from the `site.json`) with the give `<base>` value.<br>
Override the `baseUrl` property (read from the `site.json`) with the given `<base>` value.<br>
{{ icon_example }} `--baseUrl staging`

* `-s <file>`, `--site-config <file>`<br>
Specify the site config file (default: `site.json`)<br>
{{ icon_example }} `-s otherSite.json`

**{{ icon_examples }}**
* `markbind build`
* `markbind build ./myWebsite` : Generates the site from the `myWebsite` directory.
* `markbind build ./myWebsite ./myOutDir` : Generates the site to the directory named `myOutDir` in the current directory.
* `markbind build ./myWebsite ./myWebsite/myOutDir` : Generates the site to the directory named `myOutDir` in the `myWebsite` directory.
* `markbind build ./stagingDir --baseUrl staging`
* `markbind build` : Generates the site from the current working directory.
* `markbind build ./myWebsite` : Generates the site from the `./myWebsite` directory.
* `markbind build ./myWebsite ./myOutDir` : Generates the site from the `./myWebsite` directory to the `./myOutDir` directory.
* `markbind build ./stagingDir --baseUrl staging` : Generates the site from the `./stagingDir` directory, with the `baseUrl` property in `site.json` set to `staging`.

</panel>

Expand Down Expand Up @@ -203,9 +202,9 @@ The caveat is that not building all pages during the initial process, or not reb
%%{{ icon_info }} Related: [User Guide: Deploying the Website](deployingTheSite.html).%%

**{{ icon_examples }}**
* `markbind deploy`
* `markbind deploy ./myWebsite` : Generates and deploys the site from the `myWebsite` directory.
* `markbind deploy --no-build` : Deploys the site without generating it first.
* `markbind deploy` : Deploys after generating the site from the current working directory.
* `markbind deploy ./myWebsite` : Deploys after generating the site from the `./myWebsite` directory.
* `markbind deploy --no-build` : Deploys the site from the current working directory without generating it.

</panel>

Expand Down

0 comments on commit c5263ba

Please sign in to comment.