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.
This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.
# 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**
< p align = "center" >
< img src = "./image.gif" alt = "vss" width = "738" >
</ p >
## Caution
vss is still under development and the API is not stable.
Be aware that destructive changes will be made if you use it!
## Installation
### Get the binary
Releases ](https://github.com/zztkm/vss/releases )
### Build from source
```
cd vss
v install markdown
v . -o vss
```
## Usage
### Setup contents
Currently, be sure to configure the following
```
❯
.
├── about.md
├── config.toml
├── index.md
├── layouts
│ └── index.html
└── static
├── css
│ └── main.css
└── js
└── main.js
```
❯
```markdown
# Open Sea
A static site generator
- [GitHub ](https://github.com/zztkm )
[about page ](./about.md )
```
❯
```toml
title = "Open Sea"
description = "Takumi Tsuruta's home page"
baseUrl = 'https://zztkm.github.io/vss/'
```
❯
```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
```
```
Output
```
❯
dist
├── about.html
├── css
│ └── main.css
├── index.html
└── js
└── main.js
```
❯
```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 ](https://github.com/zztkm/vss/tree/main/example ) directory.