Skip to content

Commit

Permalink
📝 Add docs site to README
Browse files Browse the repository at this point in the history
  • Loading branch information
AnandChowdhary authored Oct 27, 2019
1 parent 4300a9c commit a487a77
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 📑 Staart Site
[![Staart Site](https://raw.githubusercontent.com/staart/staart.js.org/master/assets/svg/site.svg?sanitize=true)](https://staart.js.org/site)

Staart Site is a docs/helpdesk website starter with static site generator written in TypeScript. It creates tiny, accessible, and beautiful webpages.
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 |
| - | - |
Expand Down Expand Up @@ -51,6 +51,12 @@ generate({ /* options */ })
.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)
- [Updating Staart Site](https://staart.js.org/site/update.html)

## 🛠️ Configuration

You can create a `.staartrc` file or another [Cosmiconfig](https://github.com/davidtheclark/cosmiconfig)-compatible configuration file, like `staart.config.js` or the `staart` key in `package.json`. You can also supply these options as an object parameter to the `generate` function.
Expand Down Expand Up @@ -88,6 +94,19 @@ Staart Site also uses the `repository` and `author` fields for copyright/last mo

- **[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/o15y/staart) | Node.js backend with RESTful APIs | [![Travis CI](https://img.shields.io/travis/o15y/staart)](https://travis-ci.org/o15y/staart) [![GitHub](https://img.shields.io/github/license/o15y/staart.svg)](https://github.com/o15y/staart/blob/master/LICENSE) [![npm package version](https://img.shields.io/npm/v/@staart/manager)](https://www.npmjs.com/package/@staart/manager) |
| [🌐 Staart UI](https://github.com/o15y/staart-ui) | Frontend Vue.js Progressive Web App | [![Travis CI](https://img.shields.io/travis/o15y/staart-ui)](https://travis-ci.org/o15y/staart-ui) [![GitHub](https://img.shields.io/github/license/o15y/staart-ui.svg)](https://github.com/o15y/staart-ui/blob/master/LICENSE) [![npm package version](https://img.shields.io/npm/v/@staart/ui)](https://www.npmjs.com/package/@staart/ui) |
| [📑 Staart Site](https://github.com/staart/site) | Static site generator for docs/helpdesk | [![Travis CI](https://img.shields.io/travis/staart/site)](https://travis-ci.org/staart/site) [![GitHub](https://img.shields.io/github/license/staart/site.svg)](https://github.com/staart/site/blob/master/LICENSE) [![npm package version](https://img.shields.io/npm/v/@staart/site)](https://www.npmjs.com/package/@staart/site) |
| [📱 Staart Native](https://github.com/o15y/staart-native) | React Native app for Android and iOS | [![Travis CI](https://img.shields.io/travis/o15y/staart-native)](https://travis-ci.org/o15y/staart-native) [![GitHub](https://img.shields.io/github/license/o15y/staart-native.svg)](https://github.com/o15y/staart-native/blob/master/LICENSE) [![npm package version](https://img.shields.io/npm/v/@staart/native)](https://www.npmjs.com/package/@staart/native) |
| [🎨 Staart.css](https://github.com/o15y/staart.css) | Sass/CSS framework and utilities | [![Travis CI](https://img.shields.io/travis/o15y/staart.css)](https://travis-ci.org/o15y/staart.css) [![GitHub](https://img.shields.io/github/license/o15y/staart.css.svg)](https://github.com/o15y/staart.css/blob/master/LICENSE) [![npm package version](https://img.shields.io/npm/v/@staart/css)](https://www.npmjs.com/package/@staart/css) |

## 📄 License

- Code: [MIT](https://github.com/staart/site/blob/master/LICENSE)
Expand Down

1 comment on commit a487a77

@vercel
Copy link

@vercel vercel bot commented on a487a77 Oct 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.