Squarkdown CLI

Access Squarkdown’s features through the CLI.

To run these commands, you’ll need to have cloned the StrangerQuarkdown repo as a submodule into your project, and installed Ruby. Remember to also install StrangerQuarkdown’s dependencies before using it:

/your-project/stranger-quarkdown> bundle install

rake init

/your-project/stranger-quarkdown> rake init

#  ┌  Welcome to Squarkdown!  ──────────────────────────────────────────
#  │
#  ▸  You’re running version 3.1.0
#  └  any key to continue
#  ...

Setup a Squarkdown project. Builds your squarkup.json for you.

rake squark

/your-project/stranger-quarkdown> rake squark
#  >>> Squark / running Squarkdown v3.2.0
#             / locating routes...
#             ✓ found root = /your-project/stranger-quarkdown
#             ✓ found root = /your-project

Run squarkup on your project.

To preprocess other aspects, first ensure you have configured them in squarkup.json, then opt-in when running the command by supplying them as arguments:

/your-project/stranger-quarkdown> rake squark[fonts,scss,assets]

# or any subset
/your-project/stranger-quarkdown> rake squark[fonts,assets]

# in any order
/your-project/stranger-quarkdown> rake squark[assets,scss]

Since these may not change very often, you can often skip preprocessing for them to speed up development build times. You may find it helpful to configure 2 separate squarkup commands in your package.json, e.g.

// package.json
{
  // ..
  "scripts": {
    "squark": "cd stranger-quarkdown && rake squark",
    "squarkx": "cd stranger-quarkdown && rake squark[fonts,scss,assets]",
  },
  // ..
}

rake skeleton

/your-project/stranger-quarkdown> rake skeleton

Builds a Svelte/Kit project with Squarkdown, MDsveX and SCSS preconfigured. The skeleton is Sup2point0/svelte-core^↗. It contains some opinionated modifications to the skeleton that would otherwise be generated by npx sv create, such as using spaces and " double quotes.