Allow the *.typ file to be called something other than main.typ

Cubxity / typstudio

A W.I.P desktop application for a new typesetting language, typst.

GNU General Public License v3.0

580 stars 18 forks source link

Allow the *.typ file to be called something other than main.typ #25

Open Enivex opened 1 year ago

Enivex commented 1 year ago

This caused massive headaches for me ;)

At the very least, this limitation should be written clearly somewhere.

Cubxity commented 1 year ago

This is possible, but currently undocumented. It is possible to set the path to the main file in .typstudio/config.json.

Enivex commented 1 year ago

This is possible, but currently undocumented. It is possible to set the path to the main file in .typstudio/config.json.

Do I have to create the file myself? I wasn't able to find it.

Anyway, ideally it would detect what the main file is. Especially if there's only a single .typ file in the folder.

Cubxity commented 1 year ago

Yes, you have to manually create the file for the time being. There will be a user-friendly way to set this in the GUI in the future.

An example of config.json:

{
  "main": "main.typ"
}

caoimhebyrne commented 11 months ago

There will be a user-friendly way to set this in the GUI in the future.

We should add a warning that appears when trying to compile without a main.typ, and it will then ask "Do you want to mark the current file as the main typst file?", if the user selects yes, we will write the config.json for them/make changes to it.

We could also:

Add a context menu action to files that allows the user to mark it as the main typst file
Add a project creation wizard which will create a main.typ file automatically with some boilerplate within it

What do you think of these suggestions @Cubxity?