https://github.com/simsustech/simple-site-generator

Easily generate a simple but full-featured website.
https://github.com/simsustech/simple-site-generator

Last synced: 20 days ago
JSON representation

Easily generate a simple but full-featured website.

• Host: GitHub
• URL: https://github.com/simsustech/simple-site-generator
• Owner: simsustech
• License: mit
• Created: 2023-02-27T15:31:36.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-02T13:47:19.000Z (about 2 months ago)
• Last Synced: 2025-01-02T20:39:11.454Z (22 days ago)
• Language: Vue
• Size: 309 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple Site Generator

> Easily generate a simple but full-featured website.

### Try it online

https://codesandbox.io/p/sandbox/simple-site-generator-jdhg1d

### Web developers, designers and resellers

The goal of Simple Site Generator is to provide a platform on which web developers can easily create and maintain simple but full-featured websites.

If you are interested in providing paid templates to your customers, please contact me at info [at] simsus.tech.

### Community

Currently there are two free templates in the `@simple-site-generator/templates` package: `documentation` and `small-business`.

# Features

- Easily switch between templates with a single configuration option.

- Separation of content and style:

  - Define your content with Markdown.

  - Choose your template

- Builds a full-featured, static, Quasar Framework powered website.

- Comes with a Github workflow which automatically uploads the generated files to your server.

# Getting started

Initialize a simple site generator project:

```bash

pnpm create simple-site-generator ssg

cd ssg

pnpm i

pnpm run dev

git init

# Add your github repository as a remote source

```

On Github, define the following action secrets:

- DEPLOY_HOST: IP address or hostname of your server

- DEPLOY_USER: SSH user on your server

- DEPLOY_KEY: SSH key corresponding to the user

- ~~SIMSUSTECH_NPM_TOKEN: NPM access token for npm.simsus.tech~~

If you have `rsync` installed on your server/host, you can then push to the `production` branch and it will upload your website to `/srv/${URL}`.

> **Note**

> Change the `template` variable in `vitrify.config.ts` to `small-business` to experience the ease of changing the template of your website.

# API

[PageProps can be defined in the frontmatter of your Markdown files.](/packages/templates/src/index.ts)