Easy-to-use static site generator

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

zztkm 906ec9fccb Merge pull request #62 from vssio/renovate/actions-checkout-4.x chore(deps): update actions/checkout action to v4		5 months ago
.github	Merge pull request #62 from vssio/renovate/actions-checkout-4.x	5 months ago
commands	refactor: change the structure of commands	12 months ago
example	feat: remove the process of conv md ext to html	12 months ago
internal	merged vss.v into main.v	12 months ago
misc	🔨 update archive script	2 years ago
testfiles	udpate: testfiles	2 years ago
.editorconfig	🎉 init	2 years ago
.gitattributes	🎉 init	2 years ago
.gitignore	🔧 update	2 years ago
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2 years ago
LICENSE	Create LICENSE	2 years ago
README.md	fix readme	2 years ago
Taskfile.yml	build: make dist with prod build	12 months ago
image.gif	add vss image	2 years ago
main.v	refactor: change the structure of commands	12 months ago
renovate.json	Add renovate.json	1 year ago
v.mod	minor version up	2 years ago

README.md

Unescape Escape

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

vss

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

# Open Sea

A static site generator

- [GitHub](https://github.com/zztkm)

[about page](./about.md)

❯ cat config.toml

title = "Open Sea"
description = "Takumi Tsuruta's home page"
base_url = 'https://zztkm.github.io/vss/'

❯ cat layouts/index.html

<!DOCTYPE html>

<head>
    <meta charset="utf-8">
    <title>@title</title>
    <base href="@baseUrl">
    <meta name="description" content="@description" />
</head>

<body>
    @contents
</body>

Build your site

vss build

Output

❯ tree dist
dist
├── about.html
├── css
│   └── main.css
├── index.html
└── js
    └── main.js

❯ cat dist/index.html

<!DOCTYPE html>

<head>
    <meta charset="utf-8">
    <title>Open Sea</title>
    <base href="https://zztkm.github.io/vss/">
    <meta name="description" content="Takumi Tsuruta's home page" />
</head>

<body>
    <h1>Open Sea</h1>
<p>A static site generator</p>
<ul>
<li><a href="https://github.com/zztkm">GitHub</a></li>
</ul>
<p><a href="./about.html">about page</a></p>
</body>

Example

Examples can be found at the example directory.

Installation

(Recommended) Install Script

With Shell(For Mac & Linux):

curl -fsSL https://raw.githubusercontent.com/vssio/vss_install/main/install.sh | sh

With PowerShell(for Windows):

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

Build from source

git clone https://github.com/vssio/vss.git
cd vss

v install markdown

v . -o vss

README.md Unescape Escape

vss