Skip to content

πŸπŸ“‘ Static site generator for landing pages, docs, and more

License

Notifications You must be signed in to change notification settings

123Movies-fun/staart-site

Β 
Β 

Repository files navigation

Staart Site

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 GitHub Actions Travis CI Circle CI Azure Pipelines
Dependencies Dependencies Dev dependencies Vulnerabilities
Community Contributors GitHub Type definitions npm package version semantic-release

🌟 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));

πŸ—οΈ Built with Staart Site

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 Build status Docs npm package version
🌐 Staart UI Frontend Vue.js Progressive Web App Build status Docs npm package version
πŸ“‘ Staart Site Static site generator for docs/helpdesk Build status Docs npm package version
πŸ“± Staart Native React Native app for Android and iOS Build status Docs npm package version
🎨 Staart.css Sass/CSS framework and utilities Build status Docs npm package version
πŸ“¦ Staart Packages Helper functions and utility packages Build status Custom badge

πŸ’ Sponsors

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


Oswald Labs

O15Y

Speakup

Netlify

πŸ“„ License

About

πŸπŸ“‘ Static site generator for landing pages, docs, and more

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 74.5%
  • SCSS 15.1%
  • HTML 8.6%
  • JavaScript 1.8%