Text
Fields
Field | Type | Values | Default | Description |
---|---|---|---|---|
repo | string | ~ | Displayed name of the repository. This is injected into <title> in <head> of exported pages. | |
paths / site | string | site/ | [ relative to root ] Base directory of the site. Many other fields will provide paths relative to this directory. If your entire repo is the site, set this to "." . | |
paths / sources | array null | [ relative to root ] Squarkdown recursively searches these directories for .md files to squarkup.Use "." to target .md files in your project’s root.Set this field to null to disable Markdown exporting entirely. | ||
paths / exclude | array null | If a file’s path matches any of these RegEx patterns, squarkup will be skipped for it. Note the RegEx is matched against the file’s absolute path. | ||
paths / dest | string | src/routes/ | [ relative to site ] Markdown files are exported relative to this directory. | |
out / file-name | string | ~content | Name of exported .svx files (without the .svx file extension). | |
out / site-data | string | src/site.json | File where Squarkdown exports the site data. Relative to site. | |
opts / if-no-dir | string[] | ignore warn create | ["warn"] | Action to take if an export directory does not exist. |
opts / on-error | option | warn kill | warn | Action to take if an error is encountered while processing a file. |
bases / path | string | [ relative to site] Squarkdown looks here for templates for generated +page.svelte and +page.js . | ||
bases / page.svelte | string | [ relative to bases/path ]Squarkdown uses this file as a template for generated +page.svelte files.Required for Markdown exporting. | ||
bases / index.svelte | string null | [ relative to bases/path ]Squarkdown uses this file as a template for generated +page.svelte files for index pages. | ||
bases / page.js | string null | [ relative to site ] Squarkdown uses this file as a template for generated +page.js files.If not supplied, Squarkdown will not create +page.js files. | ||
bases / index-view | string null | The component imported and used to render page lists in index pages. If not supplied, Squarkdown will not create or inject index pages. | ||
styles / path | string | src/styles/ | [ relative to site ] Squarkdown looks here for stylesheets. | |
styles / page-styles | string | src/styles/ | [ relative to site ] Squarkdown looks here for stylesheets to inject during squarkup. | |
styles / base-style | string | article | [ relative to styles/page-styles ]Squarkdown injects this stylesheet into every page. | |
assets / path | string | assets | [ relative to root ] Squarkdown looks here for static assets to preprocess. | |
assets / site-assets | string null | [ relative to root ] Squarkdown moves assets in this directory straight to the root of site /static . | ||
assets / extensions | string[] | jpg jpeg png svg ttf otf woff | ["jpg", "jpeg", "png", "svg"] | Only files with these extensions will be preprocessed by Squarkdown. |
fonts / queries | string[] | [] | Individual URL query params for requesting fonts from Google Fonts. |