# vss
vss is an easy to use static site generator. With `layout/index.html`, Markdown
content, and a little configuration, you can easily build your website!
- **Easy** to use
- Create site content with **Markdown**
## Caution
vss is still under development and the API is not stable. Be aware that
disruptive changes may be made!
## Installation
### (Recommended) Install Script
With Shell(For Mac & Linux):
```shell
curl -fsSL https://raw.githubusercontent.com/vssio/vss_install/main/install.sh | sh
```
With PowerShell(for Windows):
```powershell
irm https://raw.githubusercontent.com/vssio/vss_install/main/install.ps1 | iex
```
More information: https://github.com/vssio/vss_install
### Get the binary
Download from [Releases](https://github.com/zztkm/vss/releases)
### Build from source
```
git clone https://github.com/zztkm/vss.git
cd vss
v install markdown
v . -o vss
```
## Usage
### Setup contents
Currently, be sure to configure the following
```
❯ tree
.
├── about.md
├── config.toml
├── index.md
├── layouts
│ └── index.html
└── static
├── css
│ └── main.css
└── js
└── main.js
```
❯ cat index.md
```markdown
# Open Sea
A static site generator
- [GitHub](https://github.com/zztkm)
[about page](./about.md)
```
❯ cat config.toml
```toml
title = "Open Sea"
description = "Takumi Tsuruta's home page"
baseUrl = 'https://zztkm.github.io/vss/'
```
❯ cat layouts/index.html
```html
@title
@contents
```
Build your site
```
vss build
```
Output
```
❯ tree dist
dist
├── about.html
├── css
│ └── main.css
├── index.html
└── js
└── main.js
```
❯ cat dist/index.html
```html
Open Sea
Open Sea
A static site generator
about page
```
## Example
Examples can be found at the
[example](https://github.com/zztkm/vss/tree/main/example) directory.