Skip to content

Sup2point0/stranger-quarkdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5deae19 · Feb 14, 2025
Jan 28, 2025
Jul 1, 2024
Jan 29, 2025
Jan 28, 2025
Feb 14, 2025
Jan 28, 2025
Feb 14, 2025
Feb 11, 2025
Feb 3, 2025
Jan 28, 2025
Nov 18, 2024
Nov 18, 2024
Jul 2, 2024
Jan 27, 2025
Jan 28, 2025
Jan 28, 2025
Jan 28, 2025
Jul 1, 2024

Repository files navigation

Stranger Quarkdown: A Successor to Quarkdown

Tests


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

Write content for a site with Squarkdown-Flavoured Markdown in any directory, then use Squarkdown to 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
  • Allow arbitrary JSON data in squark charm
  • Correct internal relative links to correct absolute links in production

Directory

I mean, these should be pretty self-explanatory, but here you go anyway ;)

folder notes
squarkdown source code
tests unit tests
docs documentation
site project site
.github/scripts helper scripts for generating docs and site

Usage

Tip

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

This project is designed to be used as a Git submodule.

Add it to a repo:

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

Make sure you’ve got your repo config in ./.squarkdown/squarkup.json if needed.

Run rake in the ./stranger-quarkdown/ directory to start the squarkup process. You can add this to your npm run build definition in package.json, so that it executes whenever you build the site:

  {
    "scripts": {
+     "build": "cd stranger-quarkdown && rake && cd .. && vite build"
    }
  }

Squarkdown will recursively look for all .md files starting from the root of the repo, and export them to .svx files in src/routes.

Many additional configurations are available to customise this process, although the defaults should cover most projects.


License

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