n/vss

No description

Find a file

zztkm 3be9a7ed53 merged vss.v into main.v the impact of this. - change factory func to public		2023-08-07 08:03:23 +09:00
.github	chore(deps): update bubkoo/auto-assign action to v3	2023-05-18 16:59:57 +00:00
commands	merged vss.v into main.v	2023-08-07 08:03:23 +09:00
example	feat: remove the process of conv md ext to html	2023-08-05 17:00:38 +09:00
internal	merged vss.v into main.v	2023-08-07 08:03:23 +09:00
misc	🔨 update archive script	2022-08-14 02:48:08 +09:00
testfiles	udpate: testfiles	2022-07-26 02:03:33 +09:00
.editorconfig	🎉 init	2022-07-23 02:12:02 +09:00
.gitattributes	🎉 init	2022-07-23 02:12:02 +09:00
.gitignore	🔧 update	2022-08-12 22:04:36 +09:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2022-08-18 21:23:59 +09:00
image.gif	add vss image	2022-08-17 04:48:50 +09:00
LICENSE	Create LICENSE	2022-08-18 21:14:42 +09:00
main.v	merged vss.v into main.v	2023-08-07 08:03:23 +09:00
README.md	fix readme	2022-11-02 15:53:07 +09:00
renovate.json	Add renovate.json	2023-05-18 15:05:10 +00:00
Taskfile.yml	ci: fix taskfile	2023-08-05 16:46:02 +09:00
v.mod	minor version up	2022-11-02 15:37:48 +09:00

README.md

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