Skip to content

Commit 3ce4a51

Browse files
committed
Fix base-href documentation. You must omit the trailing slash.
1 parent b1a17dd commit 3ce4a51

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,9 @@ By default it uses the URL fragment for routing (e.g.
7575
static file hosts.
7676

7777
To use the real URL path for routing, set the `base-href` property to the
78-
server mount point (e.g. `/` or `/docs/`). Note that this requires a host that
79-
serves the application from all paths that should be handled by the doc viewer.
78+
server mount point (e.g. `/api/docs` or *empty string* for the root path). Note
79+
that this requires a host that serves the application from all paths that
80+
should be handled by the doc viewer.
8081

8182
### Previous versions
8283

iron-component-page.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,12 @@
153153

154154
/**
155155
* By default all routing is performed using the URL fragment
156-
* (e.g. `docs.html#/elements/my-element`). If your server supports
157-
* it and you would like to use the real URL path instead (e.g.
158-
* `/docs/elements/my-element`), set this to the base path where the
159-
* page is mounted (e.g. `/` or `/docs/`).
156+
* (e.g. `docs.html#/elements/my-element`).
157+
*
158+
* If your server supports it and you would like to use the real URL
159+
* path instead (e.g. `/api/docs/elements/my-element`), set this to
160+
* the base path where the page is mounted, omitting the trailing
161+
* slash (e.g. `/api/docs` or *empty string* for the root path).
160162
*/
161163
baseHref: String,
162164

0 commit comments

Comments
 (0)