Skip to content

Updated documentation for basename? #3971

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

Closed
chrylis opened this issue Sep 28, 2016 · 2 comments · Fixed by #3973
Closed

Updated documentation for basename? #3971

chrylis opened this issue Sep 28, 2016 · 2 comments · Fixed by #3973

Comments

@chrylis
Copy link

chrylis commented Sep 28, 2016

I am trying to configure my app with a basename, but it looks like the documentation has vanished. Multiple places link to BasenameSupport.md (e.g., API.md), but it's 404.

@pshrmn
Copy link
Contributor

pshrmn commented Sep 29, 2016

@chrylis Assuming you are using RR v2/v3, try https://github.com/mjackson/history/blob/v2.x/docs/BasenameSupport.md. For v4 basenames are set in the Router components.

There are a few other links that seem to be affected by this. Fixing should just be a matter of updating links that point to /history/blob/master/ to /history/blob/v2.x/.

@nareshbhatia
Copy link

nareshbhatia commented Nov 5, 2016

In the link provided above, it says:

In HTML documents, you can use the element's href attribute to specify a basename for the page. This way, you don't have to manually pass the basename property to your createHistory function.

Does this mean that it is ok to use the <base> tag now? RR v2 gives a warning if I do that but RR v3 does not.

Also reading the documentation, it is not clear what issue is basename solving vs. <base> tag. When do I use one vs. the other?

@lock lock bot locked as resolved and limited conversation to collaborators Jan 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants