FAQ

Why does Squarkdown only work with SvelteKit and MDsveX?

Yeah, Squarkdown was made for a very particular purpose. It’s totally geared towards the technologies I use, but that’s purely because I made it for myself :P

It’s happened to be perfect for many of my projects, such as pyco:bytes, Integrity, and ofc Assort. It really does make development so much easier when I don’t have to worry about where I put everything. After having all the infrastructure set up, being able to just add comments to a .md file and have it automatically render to a webpage complete with metadata is pretty awesome. The best part is, you can’t even see any of it when previewing the Markdown file!

Where does the name Squarkdown come from?

Squarkdown is an abbreviation of the full name StrangerQuarkdown. It’s the successor to my original tool Quarkdown (now deprecated). You can find out more in Synopsis!

How fast is Squarkdown?

Eh, decently? It really depends how many files you have. The more Squarkdown has to search through and parse, the longer squarkup will take. This is why setting your sources properly is important!

For my personal wiki Assort, currently my largest project that uses Squarkdown, it ends up scanning 350+ files and 600+ assets during squarkup,¹ taking around 3 seconds. Execution time varies a lot depending on system speed and delays.

Why Ruby?

It’s a cute language :3 I needed an excuse (or rather, a project) to use it, so I decided I’d give writing Squarkdown in Ruby. It went pretty swimmingly, to be honest, almost zero hitches. Ruby just works ^v^

Was this website built with Squarkdown?

Of course! (Imagine if it weren’t!) The text you’re reading now is sourced from a .md file [in the Squarkdown repo] ;)

More details are available in Synopsis.