{"id":13623710,"url":"https://github.com/sphido/sphido","last_synced_at":"2026-04-04T08:02:52.188Z","repository":{"id":37396592,"uuid":"150708639","full_name":"sphido/sphido","owner":"sphido","description":"A rocket 🚀 fast, light-weight and flexible static site generator.","archived":false,"fork":false,"pushed_at":"2025-04-04T16:05:10.000Z","size":2396,"stargazers_count":40,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-08T12:50:46.607Z","etag":null,"topics":["cms","cms-framework","generator","markdown","ssg","static-site-generator"],"latest_commit_sha":null,"homepage":"https://sphido.cz","language":"TypeScript","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/sphido.png","metadata":{"files":{"readme":"readme.md","changelog":null,"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":"2018-09-28T08:21:08.000Z","updated_at":"2025-04-01T11:12:54.000Z","dependencies_parsed_at":"2022-07-08T16:47:12.831Z","dependency_job_id":"c4395765-0838-4d73-87ab-159211ff13d2","html_url":"https://github.com/sphido/sphido","commit_stats":{"total_commits":392,"total_committers":4,"mean_commits":98.0,"dds":0.528061224489796,"last_synced_commit":"22800a7047abb9e549d154ce37d471d86551a402"},"previous_names":[],"tags_count":342,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphido%2Fsphido","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphido%2Fsphido/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphido%2Fsphido/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphido%2Fsphido/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphido","download_url":"https://codeload.github.com/sphido/sphido/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249097742,"owners_count":21212345,"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":["cms","cms-framework","generator","markdown","ssg","static-site-generator"],"created_at":"2024-08-01T21:01:34.759Z","updated_at":"2026-04-04T08:02:52.181Z","avatar_url":"https://github.com/sphido.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# A rocket 🚀 fast, 💭 lightweight and flexible static site 🤖 generator.\n\n[![NPM Downloads](https://img.shields.io/npm/dm/@sphido/core?style=for-the-badge)](https://www.npmjs.com/package/@sphido/core)\n[![NPM Version](https://img.shields.io/npm/v/@sphido/core?style=for-the-badge)](https://www.npmjs.com/package/@sphido/core)\n[![NPM License](https://img.shields.io/npm/l/@sphido/core?style=for-the-badge)](https://github.com/sphido/sphido/blob/main/LICENSE)\n[![Last Commit](https://img.shields.io/github/last-commit/sphido/sphido?style=for-the-badge)](https://github.com/sphido/sphido/commits/main)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/sphido/sphido/main.yml?style=for-the-badge)](https://github.com/sphido/sphido/actions)\n\nI know, another [static site generator](https://github.com/collections/static-site-generators)! This one is different - it's totally minimalistic.\nBasically, it's just two functions. The first, the `getPages()` function, allows you to retrieve a list of pages, and the `allPages()` function allows\nyou to iterate through them.\n\nYou get a static site generator that is:\n\n- 🚀 rocket fast\n- 💭 lightweight\n- 🤘 no dependencies\n- ⚡️ flexible\n\n## Installation\n\n```shell\npnpm add @sphido/core\n```\n\nor\n\n```shell\nnpm i @sphido/core\n```\n\n## Monorepo development\n\nUse [pnpm](https://pnpm.io/); the intended version is pinned in the root `packageManager` field.\n\n```shell\npnpm install\npnpm build\npnpm test\n```\n\n## Quick Start\n\n```javascript\n#!/usr/bin/env node\n\nimport {dirname, join, relative} from 'node:path';\nimport {allPages, getPages, readFile, writeFile} from '@sphido/core';\nimport slugify from '@sindresorhus/slugify';\nimport {marked} from 'marked';\n\nconst pages = await getPages({path: 'content'}, // ... extenders\n  (page) =\u003e {\n    page.slug = slugify(page.name) + '.html';\n    page.dir = dirname(page.path);\n  });\n\nfor (const page of allPages(pages)) {\n  page.output = join('public', relative('content', page.dir), page.slug);\n  page.content = marked(await readFile(page.path));\n\n  await writeFile(page.output, `\u003c!DOCTYPE html\u003e\n  \u003chtml lang=\"en\" dir=\"ltr\"\u003e\n  \u003chead\u003e\n    \u003cmeta charset=\"UTF-8\"\u003e\n    \u003cscript src=\"https://cdn.tailwindcss.com?plugins=typography\"\u003e\u003c/script\u003e\n    \u003ctitle\u003e${page.name} | Sphido Example\u003c/title\u003e\n  \u003c/head\u003e\n  \u003cbody class=\"prose mx-auto my-6\"\u003e${page.content}\u003c/body\u003e\n  \u003c!-- Generated by Sphido from ${page.path} --\u003e\n  \u003c/html\u003e`);\n}\n```\n\nSphido requires Node.js 22 or newer. To load an ES module, set `\"type\": \"module\"` in the `package.json` or use the `.mjs` extension.\n\n## Run script\n\n```shell\nnode index.js\n```\n\n## Packages\n\n* [`@sphido/core`](https://github.com/sphido/sphido/tree/main/packages/sphido-core) - core functions `getPages()`, `allPages()`, `readFile()` and `writeFile()`\n\n### Page extenders\n\n* [`@sphido/frontmatter`](https://github.com/sphido/sphido/tree/main/packages/sphido-frontmatter) - frontmatter extender for `page`\n* [`@sphido/hashtags`](https://github.com/sphido/sphido/tree/main/packages/sphido-hashtags) - process hashtags in `page.content`\n\n### Website components\n\n* [`@sphido/sitemap`](https://github.com/sphido/sphido/tree/main/packages/sphido-sitemap) - generate `sitemap.xml` file\n\n## Examples\n\n* https://github.com/sphido/examples/\n* https://sphido.cz\n\n## License\n\n[MIT](./LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphido%2Fsphido","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphido%2Fsphido","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphido%2Fsphido/lists"}