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

TSURUTA Takumi de8a2f462d Create LICENSE		2 years ago
.github/workflows	💚 Fix Ci	2 years ago
commands	🎨 fix format	2 years ago
example	update: example files	2 years ago
misc	🔨 update archive script	2 years ago
template	✨ layout/_index.html を外部から読み込めるように変更	2 years ago
testfiles	udpate: testfiles	2 years ago
.editorconfig	🎉 init	2 years ago
.gitattributes	🎉 init	2 years ago
.gitignore	🔧 update	2 years ago
LICENSE	Create LICENSE	2 years ago
README.md	add vss image	2 years ago
Taskfile.yml	🔨 udpate	2 years ago
image.gif	add vss image	2 years ago
main.v	🎨 Maintain repository structure	2 years ago
v.mod	🔊 add logs	2 years ago

README.md

Unescape Escape

vss

Easy-to-use static site generator

Caution

vss is still under development and the API is not stable. Be aware that destructive changes will be made if you use it!

Feature

Easy to use
Create site content with markdown

Installation

Get the binary

Download from 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
├── dist
│   ├── css
│   │   └── main.css
│   └── js
│       └── main.js
├── 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"
baseUrl = '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.

README.md Unescape Escape

vss