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 |
- Zero-config, no setup required
- Scores 100/100 on Lighthouse
- Sitemap & schema data for SEO
- 1.2kb minzipped CSS, dark & light theme
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));
- Getting started
- Configuration
- Creating themes
- Redirects
- Shields.io schema
- Static files
- Updating 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 | |
π 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 |
The development of Staart projects is supported by these wonderful companies. Find us on OpenCollective
Oswald Labs |
O15Y |
Speakup |
Netlify |