{"id":20552512,"url":"https://github.com/sup2point0/stranger-quarkdown","last_synced_at":"2025-12-03T18:02:03.034Z","repository":{"id":247282486,"uuid":"822450959","full_name":"Sup2point0/stranger-quarkdown","owner":"Sup2point0","description":"Markdown preprocessing automation for Svelte/Kit projects","archived":false,"fork":false,"pushed_at":"2025-03-04T21:23:01.000Z","size":5421,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-04T22:27:08.505Z","etag":null,"topics":["markdown","mdsvex","quark","quarkdown","quarkup","ruby","squark","squarkdown","squarkup","sup","svelte","sveltekit"],"latest_commit_sha":null,"homepage":"https://sup2point0.github.io/stranger-quarkdown/docs","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sup2point0.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-01T07:18:24.000Z","updated_at":"2025-03-04T21:25:21.000Z","dependencies_parsed_at":"2024-07-12T19:36:48.708Z","dependency_job_id":"26da372a-5525-4e61-9496-4ef16e741007","html_url":"https://github.com/Sup2point0/stranger-quarkdown","commit_stats":null,"previous_names":["sup2point0/stranger-quarkdown"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sup2point0%2Fstranger-quarkdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sup2point0%2Fstranger-quarkdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sup2point0%2Fstranger-quarkdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sup2point0%2Fstranger-quarkdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sup2point0","download_url":"https://codeload.github.com/Sup2point0/stranger-quarkdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242157272,"owners_count":20081041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","mdsvex","quark","quarkdown","quarkup","ruby","squark","squarkdown","squarkup","sup","svelte","sveltekit"],"created_at":"2024-11-16T02:36:30.921Z","updated_at":"2025-12-03T18:02:03.028Z","avatar_url":"https://github.com/Sup2point0.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n![Stranger Quarkdown: A Successor to Quarkdown](.assets/squark-cover.png)\n\n[![Tests](https://github.com/Sup2point0/stranger-quarkdown/actions/workflows/test.yml/badge.svg)](https://github.com/Sup2point0/stranger-quarkdown/actions/workflows/test.yml)\n[![Site](https://github.com/Sup2point0/stranger-quarkdown/actions/workflows/site.yml/badge.svg)](https://github.com/Sup2point0/stranger-quarkdown/actions/workflows/site.yml)\n\n\u003c/div\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n[Quickstart](docs/walkthrough/quickstart.md) · [Docs](docs/) · [Site](https://sup2point0.github.io/stranger-quarkdown/docs)\n\n\u003c/div\u003e\n\n**Stranger Quarkdown** (*Squarkdown*) is a successor to [*Quarkdown*](https://github.com/Sup2point0/Quarkdown), for integration with [Svelte\u003csup\u003e↗\u003c/sup\u003e](https://svelte.dev), [SvelteKit\u003csup\u003e↗\u003c/sup\u003e](https://svelte.dev/docs/kit/introduction) and [MDsveX\u003csup\u003e↗\u003c/sup\u003e](https://mdsvex.pngwn.io).\n\nWrite content for a site with [Squarkdown-Flavoured Markdown](docs/walkthrough/quickstart.md) anywhere in your project repo, then use Squarkdown to automatically export them to `.svx` files in your SvelteKit project directory.\n\n\n\u003cbr\u003e\n\n\n## Features\n\n### Core\n- Automates several parts of the build process for SvelteKit projects\n- Multiple configuration options and Rake tasks for flexibility\n- Intelligently handles directories for more versatile navigation\n\n### Extra\n- Moves assets from a different folder to the SvelteKit `static/` directory\n- Collects fonts to build the [Google Fonts\u003csup\u003e↗\u003c/sup\u003e](https://fonts.google.com) `\u003clink\u003e` tag\n- Collects global `.scss` files to build an `scss-config.js` file\n\n### Future\n- Search root directory without recursively searching every directory\n- Allow arbitrary JSON data in squark charm\n- Correct internal relative links to correct absolute links in production\n\n\n\u003cbr\u003e\n\n\n## Directory\n\n| folder | notes |\n| :----- | :---- |\n| [`squarkdown`](squarkdown/) | source code |\n| [`cli`](cli/) | source code (CLI) |\n| [`tests`](tests/) | unit tests |\n| [`docs`](docs/) | documentation |\n| [`site`](site/) | project site |\n| [`.github/scripts`](.github/scripts/) | helper scripts for generating docs and site |\n\n\n\u003cbr\u003e\n\n\n## Usage\n\n\u003e [!Tip]\n\u003e See [Using Squarkdown in a SvelteKit project](docs/walkthrough/quickstart.md) for a full detailed walkthrough.\n\nThis project is designed to be used as a [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules).\n\nAdd it to a repo:\n\n```console\ngit submodule add https://github.com/Sup2point0/stranger-quarkdown\n```\n\nMake sure you’ve got your [repo config](docs/squarkup-config.md) in `./.squarkdown/squarkup.json`.\n\nRun `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:\n\n```diff\n  {\n    \"scripts\": {\n+     \"build\": \"cd stranger-quarkdown \u0026\u0026 rake \u0026\u0026 cd .. \u0026\u0026 vite build\"\n    }\n  }\n```\n\nSquarkdown will recursively look for all `.md` files starting from the root of the repo, and export them to `.svx` files in `src/routes`.\n\nMany additional configurations are available to customise this process (although the defaults should actually cover most projects!).\n\nFor more, visit [the docs](docs/) in this repo, or view them on [the website](https://sup2point0.github.io/stranger-quarkdown/docs).\n\n\n\u003cbr\u003e\n\n\n## License\n\nMIT. It’s not that even that good code, lmao.\n\n\n\u003cbr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsup2point0%2Fstranger-quarkdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsup2point0%2Fstranger-quarkdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsup2point0%2Fstranger-quarkdown/lists"}