Repository navigation
Bug: Docsify's path handling is problematic (and broken in some scenarios) #1891
Description
Activity
- changed the title
[-]Bug: Docsify's path handling is problematic and/or broken[/-][+]Bug: Docsify's path handling is problematic (and broken in some scenarios)[/+]on Sep 19, 2022 @jhildenbiddle I agree with you about the
path issuesin docsify and the whole pic designs which we need take care.
About the:basepathconfig, It indicates the base path directly with/ path/or even../path/scenarios, if we support the newpathconfig, I think we may need refactorgetAndRemoveConfig#1825 in advance.Hi, I am currently encountering the problem of resolving absolute paths to relative paths, using the basepath mentioned in the issue, but it did not solve the problem.
Reacted by Chaoses-Ib and AmirAny news in this issue?
I am currently encountering issue 2, and I do not want to change my document directory structure. Is there any way to resolve this?
- pinned this issue
on Feb 9, 2024 I am currently encountering issue 2, and I do not want to change my document directory structure. Is there any way to resolve this?
Hi @L-Super , could provide more details on your issue? and I may find a workaround to solve it before we settle this issue down.
For path related issue, consider tryaliasor rewrite it in hooks instead of re- structure your docs totally.I am currently encountering issue 2, and I do not want to change my document directory structure. Is there any way to resolve this?
Hi @L-Super , could provide more details on your issue? and I may find a workaround to solve it before we settle this issue down. For path related issue, consider try
aliasor rewrite it in hooks instead of re- structure your docs totally.I placed this repo under the docs folder and renamed SUMMARY.md to guide.md, while my directory structure for docs is as follows:
index.html:
<body> <div id="app"></div> <script> window.$docsify = { name: '<span>docsify</span>', logo: '/favicon.svg', relativePath: true, loadSidebar: 'guide.md', auto2top: true, loadNavbar: true, subMaxLevel: 2, mergeNavbar: true, repo: 'https://github.com/L-Super', pagination: { previousText: '上一章节', nextText: '下一章节', crossChapter: true, crossChapterText: true, }, loadFooter: true, baiduTjId: "xxxx", // 广告配置 ads: [ { img: 'resources/images/wx_qrcode.png' }, ], } window.$docsify.customPageTitle = { prefix: false, // [optional] title prefix. default: false eg: prefix: "Application" suffix: "在线充电站", // [optional] title suffix. default: false eg: suffix: "v1.0.0" separator: '|', // [optional] separator for title eg: title-> prefix | title | suffix debug: false, // [optional] should debug } </script> <!-- Docsify v4 --> <script src="resources/js/docsify.js"></script> <script src="resources/js/prism-bash.min.js"></script> <script src="resources/js/prism-cpp.min.js"></script> <script src="resources/js/docsify-pagination.min.js"></script> <script src="resources/js/docsify-footer.min.js"></script> <script src="resources/js/vanilla-back-to-top.min.js"></script> <script src="resources/js/docsify-plugin-title.min.js"></script> <script src="resources/js/docsify-ads.min.js"></script> <script src="resources/js/docsify-baidu-tj.min.js"></script> <script> addBackToTop({ diameter: 56, backgroundColor: 'rgb(66, 185, 131)', textColor: '#fff', }); </script> <script> if (typeof navigator.serviceWorker !== 'undefined') { navigator.serviceWorker.register('pwa.js') } </script> </body>
root guide.md:
* [程序员英语学习指南](/A-Programmers-Guide-to-English/README.md)
Directory structure:
docs/A-Programmers-Guide-to-English ├─assets ├─essence ├─make-a-program ├─qa ├─resources └─trainingWhen I switch between different sections from the left side, the URL shows an incorrect path.
Current behaviour：
http://localhost:3000/#/A-Programmers-Guide-to-English/essence/make-a-program/READMEExpected behaviour:
http://localhost:3000/#/A-Programmers-Guide-to-English/make-a-program/READMEReacted by Koy ZhuangHi @L-Super , I think you can try the
aliasconfig to do the trick.
You can refer our docs here to see how it works on live, we rewrite routes also, see the behavior in our site docsify here.
Line 77 in cec43d7
And if you could make a PR on your own repo (or other new place ) with the changes you mentioned above ( I could fork and reproduce it ).
I can help you to find a feasible solution as well.Hi @L-Super , I think you can try the
aliasconfig to do the trick. You can refer our docs here to see how it works on live, we rewrite routes also, see the behavior in our site docsify here.Line 77 in cec43d7
And if you could make a PR on your own repo (or other new place ) with the changes you mentioned above ( I could fork and reproduce it ).
I can help you to find a feasible solution as well.I created my repo, you can reprodeuce it.
Hi @L-Super , I think you can try the
aliasconfig to do the trick. You can refer our docs here to see how it works on live, we rewrite routes also, see the behavior in our site docsify here.
Line 77 in cec43d7
And if you could make a PR on your own repo (or other new place ) with the changes you mentioned above ( I could fork and reproduce it ).
I can help you to find a feasible solution as well.I created my repo, you can reprodeuce it.
Hi @L-Super In order not mess up this main assumption on this issue, I move it to #2370 .
Thank you John for making this extensive tracking of all the URL problems. I haven't read the whole issue, but we should eliminate custom URL handling and use the standardized
URLAPI, and paths should be have as they do naturally in vanilla web (basically we simply add.mdis a browsable file type for web sites, but we should not otherwise change standard path behavior).Reacted by John Hildenbiddle and Scruel Tao- unpinned this issue
on Mar 1, 2024 Hi, I've hit this bug while using alias and images and I was wondering if there is any progress on fixing it or a workaround?
Hi, I've hit this bug while using alias and images and I was wondering if there is any progress on fixing it or a workaround?
Hi @chetta19 , the image relative path isn't consistent to the generic behavior for now. If you have to use it.
I suppose you may have a try on building an image link post processor as an afterEach hook, which could filter links and convert it to what your expectation is.Is this issue being worked on?
Handling hyperlink paths properly is a pretty essential thing in the World Wide Web!
I'm not sure if some fixes were made in #2579, but if any new issues arise, feel free to submit an issue.
Does that mean we can expect the issue to be fixed in the next release, probably version 5.0.0?
Maybe. I just released version v5.0.0-rc.3. You can give it a try.
I tested v5.0.0-rc.3, and path handling is still broken. Attached is the simplest possible demo I could put together.
Again, the link behaviour is inconsistently wrong. Here's the project structure:
. └── DemoProject ├── DemoProjectIcon.svg ├── docs │ ├── DocsIcon.svg │ └── Docs-ReadMe.md ├── index.html └── ReadMe.mdHere's the docsify config in
DemoProject/index.html:window.$docsify = { name: "My Project's Docs", basePath: `${window.location.origin}/DemoProject`, hideSidebar: true, homepage: 'ReadMe.md', // homepage: 'docs/Docs-ReadMe.md', };
I played around with using different markdown files as the home-page, and the results were inconsistent.
- when
docs/Docs-ReadMe.mdis opened as the homepage, relative references to embedded images don't work - when
ReadMe.mdis set as the homepage, anddocs/Docs-ReadMe.mdis opened, the absolute references to embedded images don't work, but the absolute hyperlink to the ReadMe.md file does - in both cases the relative markdown file link to the parent directory doesn't work
Reacted by Ozan İrsoyReacted by Luffy- when
- marked we need a way to
":include"a remote markdown file, and all the relative URLs should be relative to that. #1977 as a duplicate of this issueon Sep 16, 2025
Bug Report
Docsify's default path handling is problematic and/or broken in several scenarios:
Docsify's path behavior is inconsistent
Docsify handles paths differently for links and other resources like images and embedded content. This inconsistency requires users to research and memorize how and why path behavior varies based on resource type which is unnecessarily confusing and makes Docsify unintuitive for users.
Docsify's relative path behavior is non-standard
Relative paths are generally expected to be relative to the context in which they are used. In the context of a website made up of a collection of separate pages, this means relative paths should be relative to the page where they are used. This provides document portability by allowing links between documents and resources to remain intact as they are moved throughout the hierarchy so long as their location relative to each other remains the same.
index.htmlroute. This makes sense from a technical perspective, but this is not expected behavior based on how relative paths work elsewhere. For sites with a flat hierarchy where theindex.htmland markdown pages are located at the root (/) this isn't an issue, but for sites with nested routes (e.g.,/dir/page.md) or a nestedindex.html(e.g.,/docs/index.html) this results in confusion, the need to use unintuitive paths, and broken or incorrect links.Docsify's absolute path behavior is non-standard
Absolute paths are generally expected to be relative to the top-most level in a domain or directory hierarchy. In the context of a Docsify site, this most commonly means the root of the domain (
/), but nested sites (/docs/index.html) may prefer to have absolute paths relative to theindex.htmlroute for site portability. This provides consistent and reliable paths to resources from any level within the hierarchy (e.g., accessing/assets/image.pngfrom/,/foo/, or/foo/bar/baz).index.htmlroute. This is not how absolute paths work elsewhere which causes confusion, the need to use unintuitive paths, and broken or incorrect links./assets/image.pngfrom/dir/page.mdusing an absolute URL.Docsify's absolute path behavior is broken for nested routes
🔴 In Docsify attempt to treat absolute non-link paths (images, embedded content, ...) as relative to the current page route, it incorrectly adds the current page route to paths that already contain the page route. For example:
Result:
Docsify does not provide a way to modify or opt-out of its problematic handling of absolute paths
This has led users resorting to using HTML instead of markdown and PRs like fix: render image in absolute path #1868 which propose working around these issues by introducing more options or custom markdown syntax. None of these would be necessary if paths simply worked the way people expected them to by default. Docsify does offer configuration options like
basePathandrelativePath, but neither of these issues allows paths in Docsify to work the way they do outside of Docsify and as people expect them to.The result has been many issues and PRs that remain unresolved. These are the ones I've found from a very simple search for "absolute" and "relative". There are most likely others that are not accounted for here.
routeRewrite/redirectsupport likealias#1982relativePath: true, even absolute paths are for icons in sidebar are resolved as relative. #877Steps to reproduce
To help others understand the problem, I have created a demo link and non-link paths can be tested:
What is current behaviour
Test results from the Codesandbox Demo can be seen in the following table:
What is the expected behaviour
basePath: Defaults tonull. Functionally the same as settingrelativeBasePathandabsoluteBasePathto the same value.relativeBasePath: Defaults to current page route. OverridesbasePath.absoluteBasePath: Defaults to/. OverridesbasePath.:basepathmarkdown attribute (or similar) should allows specifying the base path for individual elements. This is required to allow accessing resources outside of the currentindex.htmlroute when one of the base path options above would otherwise prevent it. For example:If these changes are implemented, the default behavior will be as follows: