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.

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

CLI docs #121

Merged
merged 4 commits into from
Apr 22, 2021
Merged

CLI docs #121

merged 4 commits into from
Apr 22, 2021

Conversation

matthewp
Copy link
Contributor

Changes

This is primarly for cli docs but I also added a couple of cli options;

  • --config <path> for specifying a path to the config file, mostly so people can put the in another folder. No attempt to allow a bunch of different config file options or anything like that.
  • --port <number> Specify a different port for the dev server.

Testing

CLI isn't really tested at this time. I'll try to add one for the --config at least.

Docs

  • [✅] Docs / READMEs updated
  • Code comments added where helpful

src/dev.ts Outdated Show resolved Hide resolved
src/config.ts Show resolved Hide resolved
src/cli.ts Outdated Show resolved Hide resolved
docs/cli.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Member

@drwpow drwpow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Also adds support for the `--config` option and `--port` option for the dev server.
src/dev.ts Outdated Show resolved Hide resolved
src/config.ts Show resolved Hide resolved
@matthewp
Copy link
Contributor Author

Still doing some updates, so don't merge. Great feedback!

@matthewp
Copy link
Contributor Author

Proof this is passing:

Screen Shot 2021-04-22 at 8 24 15 AM

@matthewp matthewp merged commit da033e2 into main Apr 22, 2021
@matthewp matthewp deleted the cli-docs branch April 22, 2021 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants