-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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.
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
Update CLI Reference with --site
& --base
flags
#1646
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
LGTM, @natemoo-re! Just to make sure docs are coordinated with the feature release properly, because Either this PR needs to wait on the upstream PR withastro/astro#4917 to merge, and we can apply the We can use the
(Might we want to do this anyway, in case people on older versions try to use |
Great catch, @sarah11918! Added the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good Nate! One comment with how we show these headings. Not entirely happy with my proposed argument names, happy for you to change those if you think something else would be better. (Edit: just saw your naming in the upstream PR and adjusted accordingly.)
@@ -167,6 +168,16 @@ Specifies the path to the config file relative to the project root. Defaults to | |||
astro --config config/astro.config.mjs dev | |||
``` | |||
|
|||
### `--site` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do these need to indicate the arguments they get passed like we do for --root
and --config
?
### `--site` | |
### `--site <url>` |
|
||
Configures the [`site`](/en/reference/configuration-reference/#site) for your project. Passing this flag will override the `site` value in your `astro.config.mjs` file, if one exists. | ||
|
||
### `--base` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
### `--base` | |
### `--base <pathname>` |
--site
& --base
flags
(added the flags to the PR title so we can test #1653) |
What kind of changes does this PR include?
Description
--site
flag to CLI reference, which has been supported for a long time.--base
flag to CLI reference, which is implemented in Add support for--base
CLI argument astro#4917