Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Remove project-root and config-path from documentation #685

Merged
merged 2 commits into from
Feb 19, 2024
Merged

fix: Remove project-root and config-path from documentation #685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
688de18
fix: Remove project-root and config-path from documentation
lynnpepin Feb 5, 2024
16d6895
fix: Replace and clarify config-path in the xdocumentation
lynnpepin Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions docs/src/cli/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# `oranda build`

This command builds your oranda site. You can specify:

- **The project root** (`--project-root`), in case you want to build from another directory
- **The config path** (`--config-path`), if your configuration file is not `./oranda.json`

You can also pass the `--json-only` flag in order for oranda to _only_ build an `artifacts.json` file that can
be read by other tools (or websites) for integration purposes.
This command builds your oranda site. You can pass the `--json-only` flag in order for oranda to _only_ build an
`artifacts.json` file that can be read by other tools (or websites) for integration purposes. You can also specify
`--config-path` if your configuration file is not `./oranda.json`, but oranda will still look for an
`oranda-workspace.json` in the current directory.
3 changes: 1 addition & 2 deletions docs/src/cli/dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ such, we have to take care to only run the build process when _relevant_ files c
This command also supports several options:

- `--port` to set a custom port for the file server
- `--project-root` to change the root directory from where your site will be built
- `--config-path` to specify a custom path for your oranda config
- `--config-path` to specify a custom path for your oranda config (but oranda will still look for an `oranda-workspace.json`) in your current directory).
- `--no-first-build` to skip the first step mentioned above where oranda builds your site before starting the watch process
- `-i`, `--include-paths` to specify custom paths for oranda to watch
Loading