---

Quickstart · Docs · Site

Stranger Quarkdown (Squarkdown) is a successor to Quarkdown, for integration with Svelte^↗, SvelteKit^↗ and MDsveX^↗.

Write content for a site with Squarkdown-Flavoured Markdown anywhere in your project repo, then use Squarkdown to automatically export them to .svx files in your SvelteKit project directory.

Features

Core

• Automates several parts of the build process for SvelteKit projects
• Multiple configuration options and Rake tasks for flexibility
• Intelligently handles directories for more versatile navigation

Extra

• Moves assets from a different folder to the SvelteKit static/ directory
• Collects fonts to build the Google Fonts^↗ <link> tag
• Collects global .scss files to build an scss-config.js file

Future

• Search root directory without recursively searching every directory
• Correct internal relative links to correct absolute links in production

Usage

Tip

See Using Squarkdown in a SvelteKit project for a full walkthrough.

Add Squarkdown to your project as a Git submodule:

project> git submodule add https://github.com/Sup2point0/stranger-quarkdown

Setup:

stranger-quarkdown> rake init

Run:

stranger-quarkdown> rake squark

Squarkdown will look for .md files in your repo with a <!-- #SQUARK live! --> squark, and export them to .svx files in src/routes.

Many additional configurations are available (although the defaults should actually cover most projects!).

For more, visit the docs in this repo, or view them on the website.

Licence

MIT. The code’s not even that good, lmao.