Skip to content

fix: Cannot serve off /.../index.html #1372

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.

Sign up for GitHub

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 12 commits into from
Feb 7, 2021
Merged

fix: Cannot serve off /.../index.html #1372

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
939e23b
Fix: Cannot serve off `/.../index.html`
rgladwell Sep 12, 2020
36705c7
Add end-to-end test for index file hosting
rgladwell Sep 12, 2020
e42c3df
Add code comments for explicit file changes
rgladwell Sep 14, 2020
d538c92
Add additional tests for index file hosting
rgladwell Sep 15, 2020
1868d58
Add additional tests for index file hosting
rgladwell Sep 16, 2020
8aee029
[wip] Attempt to switch tests to Jest
rgladwell Oct 19, 2020
f3362ee
Merge branch 'develop' into fix-base-path-file-not-folder
rgladwell Feb 5, 2021
f39e07c
Add e2e test for new Jest test framework
rgladwell Feb 5, 2021
5e4c790
Verify sidebar links use file hosting
rgladwell Feb 5, 2021
ac5ed77
Fix: endsWith() not supported for IE11
rgladwell Feb 6, 2021
831527f
Refactor: utility method moved to utility file
rgladwell Feb 6, 2021
d94d259
Fix IE11 error from use of String.includes()
jhildenbiddle Feb 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add code comments for explicit file changes
  • Loading branch information
@rgladwell
rgladwell committed Oct 16, 2020
commit e42c3df8d94e89c5b3bcc53077c50a980d42ef04
5 changes: 5 additions & 0 deletions src/core/router/history/hash.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ export class HashHistory extends History {
const path = window.location.pathname || '';
const base = this.config.basePath;

// This handles the case where Docsify is served off an
// explicit file path, i.e.`/base/index.html#/blah`. This
// prevents the `/index.html` part of the URI from being
// remove during routing.
// See here: https://github.com/docsifyjs/docsify/pull/1372
const basePath = path.endsWith('.html')
? path + '#/' + base
: path + '/' + base;
Expand Down
23 changes: 23 additions & 0 deletions src/core/router/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,29 @@ export const resolvePath = cached(path => {
return '/' + resolved.join('/');
});

/**
* Normalises the URI path to handle the case where Docsify is
* hosted off explicit files, i.e. /index.html. This function
* eliminates any path segments that contain `#` fragments.
*
* This is used to map browser URIs to markdown file sources.
*
* For example:
*
* http://example.org/base/index.html#/blah
*
* would be mapped to:
*
* http://example.org/base/blah.md.
*
* See here for more information:
*
* https://github.com/docsifyjs/docsify/pull/1372
*
* @param {string} path The URI path to normalise
* @return {string} { path, query }
*/

function normaliseFragment(path) {
return path
.split('/')
Expand Down