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

Improve history mode server configuration documentation to include non-root publicPath #2863

Closed
philBrown opened this issue Aug 1, 2019 · 1 comment · Fixed by #2954
Closed

Comments

@philBrown
Copy link

What problem does this feature solve?

The documentation for HTML5 History Mode - Example Server Configurations assumes all apps are running at the document root (ie /). Apps using a non-root publicPath are going to struggle with these config examples.

What does the proposed API look like?

Update the examples to include <publicPath> placeholders, eg

nginx

location <publicPath> {
  try_files $uri $uri/ <publicPath>/index.html;
}
@posva
Copy link
Member

posva commented Aug 1, 2019

I think we can add a small paragraph at the beginning, before all examples, saying that they are targeting deployments at root / and then point out about the publicPath option in CLI and relate it to base in router options

AVGP added a commit to AVGP/vue-router that referenced this issue Oct 3, 2019
posva pushed a commit that referenced this issue Oct 4, 2019
* Adds note on subfolders to history mode samples

fixes #2863

* Be a little more explicit in history mode guide

* Adds missing full stop.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants