{"id":13559019,"url":"https://github.com/staart/site","last_synced_at":"2025-10-30T08:31:11.093Z","repository":{"id":37883761,"uuid":"215200553","full_name":"staart/site","owner":"staart","description":"🏁📑 Static site generator for landing pages, docs, and more","archived":false,"fork":false,"pushed_at":"2022-12-10T22:38:38.000Z","size":4376,"stargazers_count":43,"open_issues_count":26,"forks_count":20,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-29T21:05:31.506Z","etag":null,"topics":["html","jamstack","landing-page","static-site","typescript"],"latest_commit_sha":null,"homepage":"https://staart.js.org/site","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/staart.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}},"created_at":"2019-10-15T03:41:40.000Z","updated_at":"2024-10-12T08:00:25.000Z","dependencies_parsed_at":"2023-01-26T10:01:48.368Z","dependency_job_id":null,"html_url":"https://github.com/staart/site","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/staart%2Fsite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/staart%2Fsite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/staart%2Fsite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/staart%2Fsite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/staart","download_url":"https://codeload.github.com/staart/site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238034828,"owners_count":19405680,"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":["html","jamstack","landing-page","static-site","typescript"],"created_at":"2024-08-01T12:05:17.752Z","updated_at":"2025-10-30T08:31:10.683Z","avatar_url":"https://github.com/staart.png","language":"TypeScript","funding_links":["https://opencollective.com/staart"],"categories":["TypeScript","html"],"sub_categories":[],"readme":"[![Staart Site](https://raw.githubusercontent.com/staart/staart.js.org/master/assets/svg/site.svg?sanitize=true)](https://staart.js.org/site)\n\nStaart Site is a static site generator for helpdesk or documentation websites written in TypeScript. It creates beautiful, accessible, and ultra-lightweight websites that score 100/100 on Lightbox.\n\n|              | Status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Build        | [![GitHub Actions](https://github.com/staart/site/workflows/Node%20CI/badge.svg)](https://github.com/staart/site/actions) [![Travis CI](https://img.shields.io/travis/staart/site?label=Travis%20CI)](https://travis-ci.org/staart/site) [![Circle CI](https://img.shields.io/circleci/build/github/staart/site?label=Circle%20CI)](https://circleci.com/gh/staart/site) [![Azure Pipelines](https://dev.azure.com/staart/site/_apis/build/status/staart.site?branchName=master)](https://dev.azure.com/staart/site/_build/latest?branchName=master)                                                                       |\n| Dependencies | [![Dependencies](https://img.shields.io/david/staart/site.svg)](https://david-dm.org/staart/site) [![Dev dependencies](https://img.shields.io/david/dev/staart/site.svg)](https://david-dm.org/staart/site) ![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/staart/site.svg)                                                                                                                                                                                                                                                                                                                         |\n| Community    | [![Contributors](https://img.shields.io/github/contributors/staart/site.svg)](https://github.com/staart/site/graphs/contributors) [![GitHub](https://img.shields.io/github/license/staart/site.svg)](https://github.com/staart/site/blob/master/LICENSE) ![Type definitions](https://img.shields.io/badge/types-TypeScript-blue.svg) [![npm package version](https://img.shields.io/npm/v/@staart/site)](https://www.npmjs.com/package/@staart/site) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) |\n\n## 🌟 Features\n\n- Zero-config, no setup required\n- Scores 100/100 on [Lighthouse](https://developers.google.com/web/tools/lighthouse)\n- Sitemap \u0026 schema data for SEO\n- 1.2kb minzipped CSS, dark \u0026 light theme\n\n## 💻 Getting started\n\nThe easiest way is to use `npx` to generate a static site in your current working directory:\n\n```bash\nnpx @staart/site\n```\n\nYou should see something like the following output in your terminal:\n\n```\n✔  success   Start Site built in 0.39s\n```\n\nAlternately, you can add the package as a `devDependency`:\n\n```bash\nnpm install @staart/site --save-dev\n```\n\nThen, run the `site` command to generate your static site:\n\n```bash\nnpm run site\n```\n\nOr programmatically use the `generate` function:\n\n```ts\nimport { generate } from \"@staart/site\";\n\ngenerate({\n  /* options */\n})\n  .then(() =\u003e console.log(\"Completed\"))\n  .catch(error =\u003e console.error(error));\n```\n\n## [📝 Documentation](https://staart.js.org/site)\n\n- [Getting started](https://staart.js.org/site/getting-started.html)\n- [Configuration](https://staart.js.org/site/configuration.html)\n- [Creating themes](https://staart.js.org/site/creating-themes.html)\n- [Redirects](https://staart.js.org/site/redirects.html)\n- [Shields.io schema](https://staart.js.org/site/shields-schema.html)\n- [Static files](https://staart.js.org/site/static-files.html)\n- [Updating Staart Site](https://staart.js.org/site/update.html)\n\n## 🏗️ Built with Staart Site\n\n- [Accessibility Guidelines](https://accessibilityguidelines.com)\n- [O15Y](https://o15y.com)\n- [Staart.js.org](https://staart.js.org)\n- [Uppload](https://uppload.js.org)\n- **[Add your Staart Site](https://github.com/staart/site/edit/master/README.md)**\n\n## [🏁 Staart Ecosystem](https://staart.js.org)\n\nThe Staart ecosystem consists of open-source projects to build your SaaS startup, written in TypeScript.\n\n| Package                                                  |                                         |                                                                                                                                                                                                                                                                                                                                                                                                                       |\n| -------------------------------------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [🛠️ Staart API](https://github.com/staart/api)           | Node.js backend with RESTful APIs       | [![Build status](https://img.shields.io/circleci/build/github/staart/api)](https://circleci.com/gh/staart/api) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fapi.json)](https://staart.js.org/api) [![npm package version](https://img.shields.io/npm/v/@staart/manager)](https://www.npmjs.com/package/@staart/manager)                                                 |\n| [🌐 Staart UI](https://github.com/staart/ui)             | Frontend Vue.js Progressive Web App     | [![Build status](https://img.shields.io/circleci/build/github/staart/ui)](https://circleci.com/gh/staart/ui) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fui.json)](https://staart.js.org/ui) [![npm package version](https://img.shields.io/npm/v/@staart/ui)](https://www.npmjs.com/package/@staart/ui)                                                               |\n| [📑 Staart Site](https://github.com/staart/site)         | Static site generator for docs/helpdesk | [![Build status](https://img.shields.io/circleci/build/github/staart/site)](https://circleci.com/gh/staart/site) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fsite.json)](https://staart.js.org/site) [![npm package version](https://img.shields.io/npm/v/@staart/site)](https://www.npmjs.com/package/@staart/site)                                                   |\n| [📱 Staart Native](https://github.com/staart/native)     | React Native app for Android and iOS    | [![Build status](https://img.shields.io/circleci/build/github/staart/native)](https://circleci.com/gh/staart/native) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fnative.json)](https://staart.js.org/native) [![npm package version](https://img.shields.io/npm/v/@staart/native)](https://www.npmjs.com/package/@staart/native)                                       |\n| [🎨 Staart.css](https://github.com/staart/css)           | Sass/CSS framework and utilities        | [![Build status](https://img.shields.io/circleci/build/github/staart/css)](https://circleci.com/gh/staart/css) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fcss.json)](https://staart.js.org/css) [![npm package version](https://img.shields.io/npm/v/@staart/css)](https://www.npmjs.com/package/@staart/css)                                                         |\n| [📦 Staart Packages](https://github.com/staart/packages) | Helper functions and utility packages   | [![Build status](https://img.shields.io/circleci/build/github/staart/packages)](https://circleci.com/gh/staart/packages) [![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fservices.anandchowdhary.now.sh%2Fapi%2Fgithub-files%3Frepo%3Dstaart%2Fpackages%26path%3Dpackages%26label%3Dstaart%26message%3D%25241%2524%2520package%2524S%2524%26color%3Dblueviolet)](https://www.npmjs.com/org/staart) |\n\n## 💝 Sponsors\n\nThe development of Staart projects is supported by these wonderful companies. [Find us on OpenCollective](https://opencollective.com/staart)\n\n\u003c!-- prettier-ignore --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/OswaldLabsOpenSource\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/21421587?v=4\" width=\"100px\" alt=\"\"/\u003e\u003cbr\u003e\u003csub\u003e\u003cb\u003eOswald Labs\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/O15Y\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/48348500?v=4\" width=\"100px\" alt=\"\"/\u003e\u003cbr\u003e\u003csub\u003e\u003cb\u003eO15Y\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/speakupnl\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/33686381?v=4\" width=\"100px\" alt=\"\"/\u003e\u003cbr\u003e\u003csub\u003e\u003cb\u003eSpeakup\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/netlify\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/7892489?v=4\" width=\"100px\" alt=\"\"/\u003e\u003cbr\u003e\u003csub\u003e\u003cb\u003eNetlify\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## 📄 License\n\n- Code: [MIT](https://github.com/staart/site/blob/master/LICENSE)\n- Logo and assets: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstaart%2Fsite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstaart%2Fsite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstaart%2Fsite/lists"}