github pages: how to mix quarto website with some html pages not to be rendered in quarto?

[aborruso]

Description

Hi,
I would like to build a quarto website, and render it via github pages.

I'm starting to build it, and github use docs folder to read it output-dir: docs.

In this folder, I need to have some subfolders to store HTML files that I want to publish as they are on GitHub, without having Quarto handle the rendering.
I would like to call this folder garage and I will put it in docs. In this folder "docs/garage" I will put various subfolders, and in these I will have HTML files.
How do I make sure that I do not have them deleted every time I render with quarto render? Do I have to add in the project configuration this glob in project?

  resources:
    -  "garage/*"

[mcanouil]

You can indeed resources but that not a requirement depending on how you render.

[aborruso]

Hi @mcanouil and thank you.

I usually run a default rendering. And I have set docs as output-dir.
How do I disable deletion of a specific folder located in docs?

[mcanouil]

I don't believe quarto render in a project erase the content (I am doing that for a client where R packages documentation are committed in docs alongside the Quarto documentation.

And using resources can ensure it does not happen.

[aborruso]

I don't believe quarto render in a project erase the content (I am doing that for a client where R packages documentation are committed in docs alongside the Quarto documentation.

Using quarto 1.5, it deletes all I have in docs folder.
I solved it using the mode I had thought of, which is using resources. If you can think of a more convenient way, if you have any alternative advice, I always read you with great interest.

Thank you

[mcanouil]

Using resources is the safest and more robust way to keep contents not generated by Quarto.

[jimjam-slam]

An alternate way you could do this is to keep the HTML files outside docs (eg. garage/some_file.html instead of docs/garage/some_file.html), and have a post-render script copy them into docs.

That said, my understanding is that adding resources: ["garage/*"] does something similar: it copies files from garage to docs/garage when you render. If you're storing the source HTML files in docs/garage and trying to protect them with resources, will that work?

[cderv]

I don't believe quarto render in a project erase the content

quarto render does delete output-dir content before rendering for project

quarto-cli/src/command/render/project.ts

Lines 303 to 323 in 3f492cc

	// if there is an output dir then remove it if clean is specified
	if (
	projectRenderConfig.behavior.renderAll && hasProjectOutputDir(context) &&
	(projectRenderConfig.options.forceClean ||
	(projectRenderConfig.options.flags?.clean == true) &&
	(projType.cleanOutputDir === true))
	) {
	// output dir
	const realProjectDir = normalizePath(context.dir);
	if (existsSync(projOutputDir)) {
	const realOutputDir = normalizePath(projOutputDir);
	if (
	(realOutputDir !== realProjectDir) &&
	realOutputDir.startsWith(realProjectDir)
	) {
	removeIfExists(realOutputDir);
	}
	}
	// remove index
	clearProjectIndex(realProjectDir);
	}

I solved it using the mode I had thought of, which is using resources.

This is like @jimjam-slam described. Using resources config is the way to tell quarto to copy listed content into the output directory. This is the way to tell Quarto how to include some resource in the resulting website (about site resources). So this seems to me how to do it. You could also do it as post-render script if you prefer to control the inclusion of those content in a specific way.

[mcanouil]

So --clean is set by default thus --no-clean is required if one wants to disable this feature.