https://github.com/staart/site
🏁📑 Static site generator for landing pages, docs, and more
https://github.com/staart/site
html jamstack landing-page static-site typescript
Last synced: 2 months ago
JSON representation
🏁📑 Static site generator for landing pages, docs, and more
- Host: GitHub
- URL: https://github.com/staart/site
- Owner: staart
- License: mit
- Created: 2019-10-15T03:41:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T22:38:38.000Z (over 2 years ago)
- Last Synced: 2024-10-29T21:05:31.506Z (6 months ago)
- Topics: html, jamstack, landing-page, static-site, typescript
- Language: TypeScript
- Homepage: https://staart.js.org/site
- Size: 4.17 MB
- Stars: 43
- Watchers: 3
- Forks: 20
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - staart/site - 🏁📑 Static site generator for landing pages, docs, and more (html)
README
[](https://staart.js.org/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 | [](https://github.com/staart/site/actions) [](https://travis-ci.org/staart/site) [](https://circleci.com/gh/staart/site) [](https://dev.azure.com/staart/site/_build/latest?branchName=master) |
| Dependencies | [](https://david-dm.org/staart/site) [](https://david-dm.org/staart/site)  |
| Community | [](https://github.com/staart/site/graphs/contributors) [](https://github.com/staart/site/blob/master/LICENSE)  [](https://www.npmjs.com/package/@staart/site) [](https://github.com/semantic-release/semantic-release) |
## 🌟 Features
- Zero-config, no setup required
- Scores 100/100 on [Lighthouse](https://developers.google.com/web/tools/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:
```bash
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`:
```bash
npm install @staart/site --save-dev
```
Then, run the `site` command to generate your static site:
```bash
npm run site
```
Or programmatically use the `generate` function:
```ts
import { generate } from "@staart/site";
generate({
/* options */
})
.then(() => console.log("Completed"))
.catch(error => console.error(error));
```
## [📝 Documentation](https://staart.js.org/site)
- [Getting started](https://staart.js.org/site/getting-started.html)
- [Configuration](https://staart.js.org/site/configuration.html)
- [Creating themes](https://staart.js.org/site/creating-themes.html)
- [Redirects](https://staart.js.org/site/redirects.html)
- [Shields.io schema](https://staart.js.org/site/shields-schema.html)
- [Static files](https://staart.js.org/site/static-files.html)
- [Updating Staart Site](https://staart.js.org/site/update.html)
## 🏗️ Built with Staart Site
- [Accessibility Guidelines](https://accessibilityguidelines.com)
- [O15Y](https://o15y.com)
- [Staart.js.org](https://staart.js.org)
- [Uppload](https://uppload.js.org)
- **[Add your Staart Site](https://github.com/staart/site/edit/master/README.md)**
## [🏁 Staart Ecosystem](https://staart.js.org)
The Staart ecosystem consists of open-source projects to build your SaaS startup, written in TypeScript.
| Package | | |
| -------------------------------------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [🛠️ Staart API](https://github.com/staart/api) | Node.js backend with RESTful APIs | [](https://circleci.com/gh/staart/api) [](https://staart.js.org/api) [](https://www.npmjs.com/package/@staart/manager) |
| [🌐 Staart UI](https://github.com/staart/ui) | Frontend Vue.js Progressive Web App | [](https://circleci.com/gh/staart/ui) [](https://staart.js.org/ui) [](https://www.npmjs.com/package/@staart/ui) |
| [📑 Staart Site](https://github.com/staart/site) | Static site generator for docs/helpdesk | [](https://circleci.com/gh/staart/site) [](https://staart.js.org/site) [](https://www.npmjs.com/package/@staart/site) |
| [📱 Staart Native](https://github.com/staart/native) | React Native app for Android and iOS | [](https://circleci.com/gh/staart/native) [](https://staart.js.org/native) [](https://www.npmjs.com/package/@staart/native) |
| [🎨 Staart.css](https://github.com/staart/css) | Sass/CSS framework and utilities | [](https://circleci.com/gh/staart/css) [](https://staart.js.org/css) [](https://www.npmjs.com/package/@staart/css) |
| [📦 Staart Packages](https://github.com/staart/packages) | Helper functions and utility packages | [](https://circleci.com/gh/staart/packages) [](https://www.npmjs.com/org/staart) |
## 💝 Sponsors
The development of Staart projects is supported by these wonderful companies. [Find us on OpenCollective](https://opencollective.com/staart)
Oswald Labs
O15Y
Speakup
Netlify
## 📄 License
- Code: [MIT](https://github.com/staart/site/blob/master/LICENSE)
- Logo and assets: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)