Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation

@rgladwell
Copy link
Contributor

@rgladwellrgladwell commentedSep 12, 2020•
edited
Loading

Summary

fixes#427

Docsify must be hosted on a server that supports a default directory index (i.e. maps/.../ ->/.../index.html).

Some platforms do not support this, however. For example, HTML apps hosted on the popular game/software platform, Itch.io.

This change supports hosting Docsify off an explicit path file, such as/index.html. It does this by:

  1. Preventing the/index.html part of the path being removed during routing, and
  2. Ensuring we can retrieve the source markdown using explicit path file URIs.

For example,http://example.org/index.html#/blah would be mapped to the markdown source filehttp://example.org/blah.md.

This fixes:

#427

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Repo settings
  • Other, please describe:

If changing the UI of default theme, please provide thebefore/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g.fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding anew feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open afeature request issue first and wait for approval before working on it.

@vercel
Copy link

vercelbot commentedSep 12, 2020•
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect:https://vercel.com/docsify-core/docsify-preview/1nszbjtkr
✅ Preview:https://docsify-previe-git-fork-rgladwell-fix-base-path-file-not-f15f74.docsify-core.vercel.app

@codesandbox-ci
Copy link

codesandbox-cibot commentedSep 12, 2020•
edited
Loading

This pull request is automatically built and testable inCodeSandbox.

To see build info of the built libraries, clickhere or the icon next to each commit SHA.

Latest deployment of this branch, based on commitd94d259:

SandboxSource
docsify-templateConfiguration

@rgladwell
Copy link
ContributorAuthor

The e2e tests are reported by CI as failing, but are passing locally for me.

Copy link
Member

@anikethsahaanikethsaha left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks a lot for fixing the bug.

It does seems to work and fixes the issue.

Few questions

  • It would be great to have some more test cases.
  • it would be great to have some comments for why we are doing those normalizing and those conditional check. May be linking to the issues/PR will work as well.

Also, I doubt this might be a semver-major as it can be a breaking change. cc @docsifyjs/reviewers

@rgladwell
Copy link
ContributorAuthor

@anikethsaha Thanks for the feedback. Could you clarify what sort of test cases you are looking for? I notice you have Cypress and unit tests. Which would you prefer, and where would they go exactly?

@anikethsaha
Copy link
Member

anikethsaha commentedSep 15, 2020•
edited
Loading

@anikethsaha Thanks for the feedback. Could you clarify what sort of test cases you are looking for? I notice you have Cypress and unit tests. Which would you prefer, and where would they go exactly?

You could add cypress tests for other links like

/index.md
/index.html#/
/#/index.html/
/index.html/#/ (it would be 404 but still good to cover. )

Also if there are other cases you think you can add

@rgladwell
Copy link
ContributorAuthor

@anikethsaha You could add cypress tests for other links like

Done, let me know if they're sufficient.

Copy link
Member

@anikethsahaanikethsaha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

LGTM 🎉

My only concern is whether this should be considered as breaking or not!

@rgladwell
Copy link
ContributorAuthor

It shouldn't be breaking, it's an additive change. You could argue that any breakages would be bugs.

anikethsaha reacted with thumbs up emoji

Copy link
Member

@Koooooo-7Koooooo-7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

@anikethsaha I think when it is not sure if it is a breaking change, we can make it as an option.
Giving theswitch button to users' hands.:)

@rgladwell
Copy link
ContributorAuthor

rgladwell commentedSep 17, 2020•
edited
Loading

Hmmm I think this change breaks live reloads in development mode.

anikethsaha
anikethsaha previously approved these changesSep 18, 2020
@anikethsaha
Copy link
Member

I agree that it is not a breaking change as it was a bug so probably it wasn't used before in order to avoid the bug.

@rgladwell
Copy link
ContributorAuthor

Been trying to add a feature flag for this, but the code is getting very complicated. If this isn't a breaking change, can we live without it?

@anikethsaha
Copy link
Member

cc @docsifyjs/core

@jhildenbiddle
Copy link
Member

Hey@rgladwell,

Thanks for the PR!

We recently merged#1276 intodevelop which is an overhaul of our CI and local test environments. As a result, the e2e tests in this PR will need to rewritten in Jest+Playwright instead of Cypress. The good news is that the test environments should be more stable and easier to work with. The PR contains a summary of the changes, help is available in/test/README.md directory, and I'm available if you have any questions.

@rgladwell
Copy link
ContributorAuthor

Is there some way to get a screenshot or run non-headless for the Jest e2e tests?

Docsify must be hosted on a server that supports a default directoryindex (i.e. maps `/.../` -> `/.../index.html`).Some platforms do not support this, however. For example, HTML appshosted on the popular game/software platform, Itch.io.This change supports hosting Docsify off an explicit path file, such as`/index.html`. It does this by: 1. Adding handling for paths like `index.html#/blah`, and 2. Normalising paths with fragments back to markdown pathsFor example, `http://example.org/index.html#/blah` would be mapped to`http://example.org/blah.md`.Thisfixes:docsifyjs#427
@rgladwell
Copy link
ContributorAuthor

@jhildenbiddle@anikethsaha@Koooooo-7 As requested, added e2e tests using Jest framework.

Copy link
Member

@sy-recordssy-records left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

LGTM.

note: Please usesquash and merge for merging

@sy-recordssy-records changed the titleFix #427: Cannot serve off/.../index.htmlfix: Cannot serve off/.../index.htmlFeb 7, 2021
@Koooooo-7Koooooo-7 requested a review froma teamFebruary 7, 2021 07:35
@jhildenbiddlejhildenbiddle merged commit759ffac intodocsifyjs:developFeb 7, 2021
@rgladwellrgladwell deleted the fix-base-path-file-not-folder branchFebruary 7, 2021 16:26
@rgladwell
Copy link
ContributorAuthor

Thanks!

gadhagod reacted with rocket emoji

rg-wood added a commit to grislyeye/three-meet that referenced this pull requestFeb 8, 2021
rg-wood added a commit to grislyeye/three-meet that referenced this pull requestFeb 8, 2021
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@jhildenbiddlejhildenbiddlejhildenbiddle approved these changes

@Koooooo-7Koooooo-7Koooooo-7 approved these changes

@sy-recordssy-recordssy-records approved these changes

@anikethsahaanikethsahaAwaiting requested review from anikethsaha

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fix bug where URI path is to a file and not to directory

5 participants

@rgladwell@sy-records@anikethsaha@jhildenbiddle@Koooooo-7
[8]ページ先頭
©2009-2025 Movatter.jp