Skip to content

Commit

Permalink
integrate squarkdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Sup2point0 committed Jan 28, 2025
1 parent c9d90a3 commit 6bb7b05
Show file tree
Hide file tree
Showing 9 changed files with 162 additions and 15 deletions.
37 changes: 28 additions & 9 deletions .squarkdown/squarkup.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,34 @@
{
"$schema": "https://sup2point0.github.io/stranger-quarkdown/squarkup-schema.json",
"$schema": "../squarkdown/resources/squarkup-schema.json",

"repo": "Stranger Quarkdown",
"site": "site",
"sources": ["docs"],
"repo": "Squarkdown",

"styles": "styles",
"assets": ".assets",
"fonts": [
"Fira+Sans"
"paths / site": "site",
"paths / sources": [
".",
"docs"
],
"paths / exclude": null,
"paths / dest": "src/routes/(docs)/",
"out / file-name": "~content",
"out / site-data": "src/site.json",

"if-no-dir": ["warn", "create"]
"opts / if-no-dir": ["warn", "create"],
"opts / on-error": "kill",

"bases / path": "src/parts/bases/",
"bases / page.svelte": "~page.svelte",
"bases / page.js": "~page.js",
"styles / path": "src/styles/",
"styles / page-styles": "src/styles/",
"styles / base-style": "article",
"assets / path": ".assets",
"assets / site-assets": ".assets/site",
"assets / extensions": [
"jpg", "jpeg", "png", "svg", "ttf"
],
"fonts / queries": [
"Fira+Sans:ital,wght@0,200;0,300;0,400;0,500;0,600;0,700;1,200;1,300;1,400",
"Sora:wght@100..800"
]
}
3 changes: 3 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
~content.svx

# output
build/
static/

# internal
node_modules/
Expand Down
65 changes: 65 additions & 0 deletions site/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
"devx": "npm run prep && vite --open",
"prep": "npm run squark",
"prepx": "npm run squarkx",
"squark": "cd .. && rake squark[fonts,scss] && cd ../site",
"squarkx": "cd .. && rake squark[fonts,scss,assets] && cd ../site",
"squark": "cd .. && rake squark[fonts,scss] && cd site",
"squarkx": "cd .. && rake squark[fonts,scss,assets] && cd site",
"build": "vite build",
"preview": "vite preview"
},
Expand All @@ -17,6 +17,8 @@
"@sveltejs/kit": "^2.0.0",
"@sveltejs/vite-plugin-svelte": "^4.0.0",
"mdsvex": "^0.11.2",
"remark-footnotes": "^2.0.0",
"remark-numbered-footnote-labels": "^1.1.0",
"sass": "^1.83.4",
"svelte": "^5.0",
"svelte-preprocess": "^6.0.1",
Expand Down
1 change: 1 addition & 0 deletions site/scss-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
const scssConfig = {
prependData: `
@use './src/styles//mixins/~fonts.scss' as *;
@use './src/styles//mixins/~links.scss' as *;
@use './src/styles//mixins/~colours.scss' as *;
`
};
Expand Down
5 changes: 5 additions & 0 deletions site/src/parts/bases/~page.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export async function load()
{
let data = await import("./~content.svx");
return data.metadata;
}
8 changes: 8 additions & 0 deletions site/src/parts/bases/~page.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<script>
import Content from "./~content.svx";
</script>


<Content />
46 changes: 42 additions & 4 deletions site/src/site.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"meta": {
"exported": "2025-01-28",
"file_count": 10,
"page_count": 1
"file_count": 11,
"page_count": 3
},
"index": {},
"shard": {},
"tags": {},
"pages": {
"edu.md": {
"path": "edu.md",
Expand All @@ -22,7 +22,45 @@
"capt": null,
"desc": "Lessons learnt from development",
"index": [],
"shard": [],
"tags": [],
"date": null,
"date_display": null
},
"docs/README.md": {
"path": "docs/README.md",
"last_deploy": "2025-01-28 19:25:27 +0000",
"slocs": 40,
"chars": 704,
"isIndex": false,
"flags": [
"live"
],
"dest": "docs",
"title": "Squarkdown Docs",
"head": "Squarkdown Docs",
"capt": null,
"desc": null,
"index": [],
"tags": [],
"date": null,
"date_display": null
},
"docs/further-walkthrough.md": {
"path": "docs/further-walkthrough.md",
"last_deploy": "2025-01-28 20:18:12 +0000",
"slocs": 145,
"chars": 4503,
"isIndex": false,
"flags": [
"live"
],
"dest": "docs/further-walkthrough",
"title": "Making Full Use of Squarkdown",
"head": "Making Full Use of Squarkdown",
"capt": "A Further Walkthrough of Additional Squarkdown Features",
"desc": "A further walkthrough of additional Squarkdown features",
"index": [],
"tags": [],
"date": null,
"date_display": null
}
Expand Down
6 changes: 6 additions & 0 deletions site/svelte.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import adapter from "@sveltejs/adapter-static";
import { sveltePreprocess } from "svelte-preprocess";

import { mdsvex } from "mdsvex";
import remarkFootnotes from "remark-footnotes";
import remarkIndexFootnotes from "remark-numbered-footnote-labels";

import scss_config from "./scss-config.js";

Expand Down Expand Up @@ -34,6 +36,10 @@ const config = {
preprocess: [
mdsvex({
extensions: [".md", ".svx"],
remarkPlugins: [
remarkFootnotes,
remarkIndexFootnotes,
],
}),
sveltePreprocess({
scss: scss_config,
Expand Down

0 comments on commit 6bb7b05

Please sign in to comment.