{"id":13872010,"url":"https://github.com/stackotter/scute","last_synced_at":"2025-07-12T01:33:34.828Z","repository":{"id":113773361,"uuid":"478319468","full_name":"stackotter/scute","owner":"stackotter","description":"An extensible static site generation tool built with Swift.","archived":false,"fork":false,"pushed_at":"2023-07-24T22:11:29.000Z","size":243,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-13T04:16:22.896Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackotter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"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},"funding":{"github":"stackotter"}},"created_at":"2022-04-05T22:25:32.000Z","updated_at":"2025-05-05T23:01:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"f2cdd05a-33b0-4db6-ac10-d051453e8061","html_url":"https://github.com/stackotter/scute","commit_stats":{"total_commits":46,"total_committers":1,"mean_commits":46.0,"dds":0.0,"last_synced_commit":"e4e4573609fab36f9e496a36db084e748f59460f"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/stackotter/scute","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackotter%2Fscute","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackotter%2Fscute/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackotter%2Fscute/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackotter%2Fscute/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackotter","download_url":"https://codeload.github.com/stackotter/scute/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackotter%2Fscute/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264923173,"owners_count":23683717,"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":[],"created_at":"2024-08-05T23:00:32.273Z","updated_at":"2025-07-12T01:33:34.765Z","avatar_url":"https://github.com/stackotter.png","language":"Swift","funding_links":["https://github.com/sponsors/stackotter"],"categories":["Swift"],"sub_categories":[],"readme":"# Scute - *Site Creation (u) Tool (e)*\n\nAn extensible static site generator. Supports macOS and Linux.\n\n## Overview\n\nScute is a markdown-oriented static site generation tool. Pages are created using markdown,\nand automatically generated elements such as tables of contents and blog post lists are\nimplemented via custom markdown plugins (e.g. `@TableOfContents{depth:2}@`).\n\nThe structure of your website is purely controlled by the structure of your source files and\ndirectories, keeping things simple.\n\nGitHub flavoured markdown is supported.\n\nIn future I hope to make a simple mechanism for site creators to implement their own plugins\nto further customise the site generator.\n\n## Installation\n\n`scute` hasn't been added to homebrew yet, and mint can't successfully install it, so for now\nit must be installed manually.\n\n```sh\ngit clone https://github.com/stackotter/scute\ncd scute\nswift build -c release\nsudo cp .build/release/scute /usr/local/bin\n```\n\n## Quickstart\n\n```sh\nscute create site_name\ncd site_name\nscute preview\n```\n\nIf hosting with Vercel, you can use `scute create site_name --vercel` to automatically\ncreate the required `vercel.json` file along with your website.\n\n## Configuration\n\nEvery scute project has a `Scute.toml` configuration file. The following example showcases\nall available configuration options.\n\n```toml\nconfig_version = 1 # always 1 for now\nname = \"Website Name\"\ninput = \"./src\"\noutput = \"./build\"\npage_template = \"./src/_template.html\"\nsyntax_theme = \"atom-one-dark\"\n```\n\n## Customisation\n\n### Customising theme\n\nTo customise a Scute site all you need to know is HTML and CSS. Just modify your page template\n(located at `src/_template.html` by default) and the stylesheet (located at `src/css/page.css`\nby default).\n\n### Adding pages\n\nTo add a page simply create a new markdown file and the route to that file once built will\nmatch the path to the file on disk (relative to the input directory). For example, creating\n`src/achievements.md` will create a new page at `/achievements`, and so will creating a file\nat `src/achievements/index.md`.\n\n### Adding resources\n\nTo add resources to your website, simply just add them to the input folder wherever you want.\nAny files that aren't handled by a plugin (only `markdown` and `css` by default) will get\ncopied as-is to the output directory (preserving their location in the folder structure).\n\n## Features\n\n- GitHub flavoured markdown\n- CSS minification (unused rules are removed)\n- Code block syntax highlighting\n- Auto-generated header ids for linking between sections\n- Automatic table of contents generation markdown extension\n- Automatic article list generation markdown extension\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackotter%2Fscute","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackotter%2Fscute","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackotter%2Fscute/lists"}