ProjectScaffold icon indicating copy to clipboard operation
ProjectScaffold copied to clipboard

Locally-generated documentation has incorrect link to local css and js

Open isaacabraham opened this issue 11 years ago • 2 comments

On the latest version, I took a clean download, ran build.cmd with some project name. It correctly built and generated everything.

However, the paths to both the "style.css" and "tips.js" in the html output files e.g. content.html are incorrect. They point to "/project-name/content/style.css" and "/project-name/content/tips.js" (where project-name = the name of your project) when they should in fact point to simply "content/style.css" and "content/tips.js" i.e. without the /project-name/ prefix.

isaacabraham avatar Oct 09 '14 21:10 isaacabraham

OK. I've dug into this a bit more. I think it's more an education issue (which we've already spoken about):

It's because the default generatedocs task in build.fsx --defines the RELEASE flag, which tells the document generator to use the website relative style URI rather than a physical path. If you remove this flag, it generates a valid local URI.

Happy to close this as user error but probably should go into a help guide - or perhaps a way to specify whether you want to generate the docs for local or "live" use.

isaacabraham avatar Oct 12 '14 21:10 isaacabraham

Glad you were able to dig into this.

What I usually do is create a "PreviewDocs" task which runs the generate script with DEBUG defined. I'm planning to add this to the default build script. And I will certainly mention all of this in the forthcoming walk-through like.

Thanks tons for the very useful feedback.

pblasucci avatar Oct 12 '14 21:10 pblasucci