docs: note the importance of base in hash mode

Close #685

diff --git a/docs/api/index.md b/docs/api/index.md
index 06f06a27bde187fa38c84f8f8fe74a43156a0819..bd00d1cd853a4ff2275c0371ca2905e55e06ddaf 100644 (file)
--- a/docs/api/index.md
+++ b/docs/api/index.md
@@ -227,9 +227,10 @@ export declare function createWebHashHistory(base?: string): RouterHistory
 
 ### Parameters
 
-| Parameter | Type     | Description                                                                                                                                         |
-| --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| base      | `string` | optional base to provide. Defaults to `location.pathname` or `/` if at root. If there is a `base` tag in the `head`, its value will be **ignored**. |
+| Parameter | Type     | Description                                                                                                                                                                                                                                                                                                                                                  |
+| --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| base      | `string` | optional base to provide. Defaults to `location.pathname` or `/` if at root. If there is a `<base>` tag in the `head`, its value will be ignored in favor of this parameter **but note it affects all the history.pushState() calls**, meaning that if you use a `<base>` tag, its `href` value **has to match this parameter** (ignoring anything after the |
+| `#`)      |
 
 ### Examples
 

diff --git a/src/history/hash.ts b/src/history/hash.ts
index 7efeb5e437231409476e495339e142d864404529..9768b077a4958814e1b891e1274feb8fa1b7958f 100644 (file)
--- a/src/history/hash.ts
+++ b/src/history/hash.ts
@@ -4,11 +4,14 @@ import { warn } from '../warning'
 
 /**
  * Creates a hash history. Useful for web applications with no host (e.g.
- * `file://`) or when configuring a server to handle any URL.
+ * `file://`) or when configuring a server to handle any URL is not possible.
  *
  * @param base - optional base to provide. Defaults to `location.pathname` or
- * `/` if at root. If there is a `base` tag in the `head`, its value will be
- * **ignored**.
+ * `/` if at root. If there is a `<base>` tag in the `head`, its value will be
+ * ignored in favor of this parameter **but note it affects all the
+ * history.pushState() calls**, meaning that if you use a `<base>` tag, it's
+ * `href` value **has to match this parameter** (ignoring anything after the
+ * `#`).
  *
  * @example
  * ```js