Skip to content
πŸπŸ“‘ Static site generator and starter for helpdesk/docs sites
TypeScript CSS HTML JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci πŸ‘· Lint CI config files Nov 5, 2019
.github/workflows πŸ‘· Lint CI config files Nov 5, 2019
content πŸ’„ Style about author section Jan 2, 2020
setup
src ✨ Support for custom header title Jan 23, 2020
.gitattributes
.gitignore πŸ™ˆ Add .gitignore Oct 15, 2019
.staartrc ✨ Support for custom header title Jan 23, 2020
.travis.yml πŸ’š Remove Travis deploy Feb 11, 2020
CHANGELOG.md πŸš€ Deploy v1.13.1 Jan 23, 2020
LICENSE πŸ“„ Add MIT license Oct 15, 2019
README.md πŸ“ Add Staart Packages, CircleCI badge Jan 23, 2020
azure-pipelines.yml πŸ‘· Lint CI config files Nov 5, 2019
package.json ⬆️ Bump @types/node from 13.7.1 to 13.7.2 Feb 19, 2020
tsconfig.json πŸ”§ Add tsconfig.json Oct 15, 2019
yarn.lock ⬆️ Bump @types/node from 13.7.1 to 13.7.2 Feb 19, 2020

README.md

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

🌟 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

πŸ—οΈ Built with 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 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

πŸ“„ License

You can’t perform that action at this time.