https://github.com/veltiosoft/vss

Easy-to-use static site generator
https://github.com/veltiosoft/vss

cli cms content-management-system static-site-generator v vlang

Last synced: about 1 month ago
JSON representation

Easy-to-use static site generator

• Host: GitHub
• URL: https://github.com/veltiosoft/vss
• Owner: veltiosoft
• License: mit
• Created: 2022-07-22T17:11:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-09T11:50:18.000Z (4 months ago)
• Last Synced: 2024-11-13T16:00:38.348Z (about 1 month ago)
• Topics: cli, cms, content-management-system, static-site-generator, v, vlang
• Language: V
• Homepage:
• Size: 7.1 MB
• Stars: 33
• Watchers: 2
• Forks: 3
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-v - vss - Easy-to-use static site generator. (Applications / Web)

README

        
# 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**



  



![CI](https://github.com/zztkm/vss/workflows/CI/badge.svg)

## Caution

vss is still under development and the API is not stable. Be aware that

disruptive changes may be made!

## 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"

base_url = '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



GitHub



about page


```

## Example

Examples can be found at the

[example](https://github.com/zztkm/vss/tree/main/example) directory.

## 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/vssio/vss.git

cd vss

v install markdown

v . -o vss

```