Skip to content

docs(serverOptions): moved options from archived doc to the docs section #1287

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

Merged
merged 3 commits into from
Feb 19, 2021

Conversation

mfranzke
Copy link
Contributor

@mfranzke mfranzke commented Feb 5, 2021

Summary of changes:
Moved options settings for the live-server from archived document to the pages docs section, to include those options more prominently.

… docs section

to include those options more prominently
| host | "0.0.0.0" | Set the address to bind to. Defaults to 0.0.0.0 or process.env.IP. |
| root | "/public" | Set root directory that's being served. Defaults to cwd. |
| open | false | When false, it won't load your browser by default. |
| ignore | 'scss,my/templates' | Comma-separated string for paths to ignore. |
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs to be ignorePattern. ignore will overwrite the default not to watch public.root aka public/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@JosefBredereck good catch. I‘ve copied these out of the linked page but even also just realized that they don‘t match the implementation (any more).

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you adjust this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, sure.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@JosefBredereck I’m wondering about the best approach here.

I will insert ignorePattern. But regarding „ignore“: As it’s actually a provided option, should we either leave it out or just describe it correctly and warn about any overwriting? I tend to do the latter, to ensure completeness, avoid surprises and give those opportunities, that would like to tweak things to the next level.

What do you think?

@JosefBredereck JosefBredereck merged commit 5755602 into pattern-lab:dev Feb 19, 2021
@mfranzke mfranzke deleted the docs-serverOptions branch May 6, 2021 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants