Ergo [0.1.1] - Colorful theorems

[serene walrus]

Hello everyone! A friend and I developed Ergo which lets you write organized and unique lecture notes and problem sets with custom color schemes.
At the moment we feature 4 color schemes (including dark mode!) and 3 styles for the environments.
The package was built with expansion in mind and we plan on supporting more color schemes/styles and perhaps even user defined color schemes in the near future.

We would love to hear what you think about the project.

P.S. If you would like to have your own color scheme before we officially support it, you can install the package locally from our github project and write your own color scheme in json format as the previous color schemes were written (you may have to change some stuff in the .typ files, lmk if you want help with that).

[wild peak]

Very nice

[dawn geyser]

could you maybe at least expose stuff like proof-env?

[unborn trench]

niiiiice

is there a way to provide a custom color palette ?

[restive storm]

P.S. If you would like to have your own color scheme before we officially support it, you can install the package locally from our github project and write your own color scheme in json format as the previous color schemes were written (you may have to change some stuff in the .typ files, lmk if you want help with that).

I think that's the way to go for custom themes for now :)

[serene walrus]

We just added the functionality last night, but it is in our 0.2.0 release branch which will not be a full release likely for a few more weeks

If you want to use it now you can install it locally from the 0.2.0 branch

[unborn trench]

That was me on the issue 🙂

[serene walrus]

Oh lol, myb

[unborn trench]

(so I know ^^)

[serene walrus]

Yes, we can do this in the 0.2.0 release (not home at the moment so I can't add it)

One thing to note is that if you plan on using a separate color for a custom proof-env or statement-env you will need to use the new custom color feature we added recently to add a custom id (the id is used for assigning a color palette)

I will ping you when it's added, but as mentioned above you will have to locally install the package until 0.2.0 is a full release in a few weeks

[frozen ravine]

BTW excellent suggestion on the issue @unborn trench, I completely forgot we posted this on discord and initially didn't realize I was talking to someone who knew Typst quite well

Probably we will aim for 0.2.0 for this weekend

[unborn trench]

Personally, I find it quite nice, I've done something a bit like this for my own use, but far lass involved, with baked-in colors, and my first thought was "nice, an in-universe package, I just need to make it use the colors I need to use for stylistic coherence", nice to see the idea was well received ! It's the way I'm building the PhD thesis template for my institute, as all the faculties of the institute have their own precise designation and logo, specialty, number, etc, so I put all that in a typst dictionnary, and if in the future another faculty joins the institute, the user could just provide all the information, and the template would still do things appropriately. I also allow for the user to provide a template function for the inside of the thesis as there's no guideline there. I'm awaiting the authorizations of the institute to publish it for the typst universe, but fingers crossed

[serene walrus]

Love to hear you like the package!

Are you posting your template or is it being kept internally?

I'd love to see your use cases for ergo if you end up using it for anything (template, or not) as I currently have a very narrow usecase for it and we are always trying to make it more broadly usable

We will likely be accelerating the release of 0.2.0 since so many features are getting added with public release, so if you want I can ping you when it's released

[unborn trench]

kept internally until it goes through the approval process, as the template relies on some media under trademark and copyright, but the intent is to publish it

[unborn trench]

no need to ping me, I'll check from time to time ^^

[serene walrus]

Looking forward to seeing it, writing an undergrad thesis soon so im looking for inspiration with templates

[serene walrus]

just added this, note that you will have to use custom color schemes if you use an id that does not exist in the normal color schemes.
example:

#show: ergo-init.with(colors: json("custom.json"), headers: "sidebar")

#let custom-proof = proof-env.with(
  [Custom Proof],
  "custom-proof", // id
  false
)
#custom-proof[ Custom Proof name ][ #lorem(100) ][ #lorem(100) ]

#let custom-statement = statement-env.with(
  [Custom Statement],
  "custom-statement" // id
)
#custom-statement[ Custom Statement name ][ #lorem(100) ]

although you can also just use the existing ids such as

#show: ergo-init.with(colors: ergo-colors.bootstrap, headers: "sidebar")

#let custom-proof = proof-env.with(
  [Custom Proof],
  "theorem", // id
  false
)
#custom-proof[ Custom Proof name ][ #lorem(100) ][ #lorem(100) ]