README.md

Staart 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.

	Status
Build
Dependencies
Community

🌟 Features

• Zero-config, no setup required
• Scores 100/100 on Lighthouse
• Sitemap & schema data for SEO
• 1.2kb minzipped CSS, dark & light theme

💻 Getting started

The easiest way is to use npx to generate a static site in your current working directory:

npx @staart/site

You should see something like the following output in your terminal:

✔  success   Start Site built in 0.39s

Alternately, you can add the package as a devDependency:

npm install @staart/site --save-dev

Then, run the site command to generate your static site:

npm run site

Or programmatically use the generate function:

import { generate } from "@staart/site";

generate({
  /* options */
})
  .then(() => console.log("Completed"))
  .catch(error => console.error(error));

📝 Documentation

• Getting started
• Configuration
• Creating themes
• Redirects
• Shields.io schema
• Static files
• Updating Staart Site

🏗️ Built with Staart Site

• Accessibility Guidelines
• O15Y
• Staart.js.org
• Uppload
• Add your Staart Site

🏁 Staart Ecosystem

The Staart ecosystem consists of open-source projects to build your SaaS startup, written in TypeScript.

Package
🛠️ Staart API	Node.js backend with RESTful APIs
🌐 Staart UI	Frontend Vue.js Progressive Web App
📑 Staart Site	Static site generator for docs/helpdesk
📱 Staart Native	React Native app for Android and iOS
🎨 Staart.css	Sass/CSS framework and utilities
📦 Staart Packages	Helper functions and utility packages

💝 Sponsors

The development of Staart projects is supported by these wonderful companies. Find us on OpenCollective

Oswald Labs

O15Y

Speakup

Netlify

📄 License

• Code: MIT
• Logo and assets: CC BY 4.0