jupyter-book / mystmd

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

Support underscores for configuration file (aka, `_myst.yml`) #1164

Open choldgraf opened 4 months ago

choldgraf commented 4 months ago

We currently support a configuration file called myst.yml. When MyST sites start to have a lot of pages, it can be hard to quickly find the myst.yml file among the long list. You have to scroll down to the ms and find it there.

For users that find this annoying, we could support one or more versions of the myst.yml filename. For example, either _ or . would bump it to the top of the list of files in most file explorers, making it easier to quickly find.

Note: this might become unnecessary once we implement nested file/folders for documents:

So if this would be non-trivial to support then we could just prioritize #670 instead

parmentelat commented 2 months ago

strong agreement here 👍 I'd just like to add that #670 would not necessarily help in the case of a transition from jb1 I like that the 2 jb-related files appear close to one another among a large list of files but not enough that I'd go for the overwhelming task of splitting the contents into folders :)

to be clear, I do support #670 as well, because I need it too not because of the folder thing though - I often use a single folder - but because of the alteration in the filenames where e.g. digits get removed, as far as I can tell