Support Relative Path

[huchenme]

Docusaurus expect baseUrl to be absolute path, to use relative path, I have tried to put baseUrl='' and it does not work for docs link and generated build.

It will be nice that Docusaurus support relative mode as well

[JoelMarcey]

@huchenme Hi. What error do you get when you use baseUrl = ''? Do you get the same thing if you use baseUrl='/'?

[huchenme]

@JoelMarcey
After running npm start in develop mode, docs folder is not working, visiting http://localhost:3000/docs/abc.html will result in http://localhost:3000/docs/abc.html

After running build command, css path and docs path not working as well

[JoelMarcey]

@huchenme Hi. Do you have a repo I can look at to see your siteConfig.js? Thanks!

[huchenme]

Hi @JoelMarcey , I have just created this repo https://github.com/huchenme/docusaurus-demo

It is generated from docusaurus-init and changed the baseUrl to "", you could cd into website and try

yarn start

and click Docs header, you should able to see the error.

and then try run docusaurus build and open generated index.html, click the Docs header again, the css is not rendered correctly.

If you guys are busy, I can work on it and send a PR, is that ok with you?

[jacarma]

I think this is the same feature request: "Make the built site work without a web server"
Acceptance criteria:
yarn build
open file://{PATH}/website/build/{projectName}/index.html in a browser

Expected behaviour: You can navigate through pages and docs and links work

[stoffeastrom]

It would be really nice if this was supported. I just save my build artifacts on circle ci but the site will not work since it doesn't handle relative baseUrl e.g ./

Problems seem to be that in the generated html files css and images are referenced as

./css/main.css
./img/some-image.png

when it should have been

../css/main.css
../img/some-image.png

since they are relative to their html file.

Using the ./css/main.css will be relative to web server root

[kevinbarabash]

The problem I ran into was I want to deploy to docs to both khan.github.io/KaTeX (for production) as well as katex.netlify.com (for testing). We can probably use an environment variable to handle these different base URLs, but it would be nice if we didn't have to.

[lwasylow]

Would be great feature as its quite painful to review build on local machine

[JoelMarcey]

@endiliey - you haven't done anything around this for the next version of Docusaurus, right? I know we had #864 for static asset.

If not, could we employ something similar to what was done in KaTeX/KaTeX#1525, but within the core instead of siteConfig?