search

jupyter-book / mystmd

Command line tools for working with MyST Markdown.
https://mystmd.org/guide
MIT License
208 stars 61 forks source link

Configure the location of build outputs #527

Open peabody124 opened 1 year ago

peabody124 commented 1 year ago

Proposal

It would be great to have an option to cause Myst to use .build as the directory instead of _build

Additional notes

Dot as a prefix is more common in Unix for hidden directories, although one can imagine many cases where you don't want _build hidden by default. However, this would be particularly useful for things like keep myst documents organized in obsidian. It currently indexes anything without a . directory and that makes it much slower. Unfortunately their exclude files methods don't work reliably enough to do this yet.

Totally reasonable to get a "wontfix" since this is at least as much an obsidian problem.

nthiery commented 1 year ago

More generally, making the build directory configurable (e.g. through a command line option) would be natural. As a use case, I am now using both JupyterBook and myst in parallel, and I am a bit worried to share the same _build path for both.

fwkoch commented 5 months ago

Another use case for configuring the build came up here: https://github.com/scipy-conference/scipy_proceedings/issues/905

npm does not work in a google-drive-synced folder on windows, therefore myst does not work in that context either. Rather than moving all your content to a separate folder, it would be great to just specify a build folder outside the google drive folder. That way, content stays synced but all the build artifacts do not.

fwkoch commented 4 months ago

We may also want to make this more granular to specify different locations for different folders in the _build directory.

For example, I want my site contents in the default _build folder, but I want to use a shared templates folder across multiple projects.