From dff959135ee7cd8244af151cc2e0dbc1060031d7 Mon Sep 17 00:00:00 2001 From: zztkm Date: Fri, 19 Aug 2022 15:23:19 +0900 Subject: [PATCH] :memo: update readme --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 46cfda5..593fc4d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ # vss -Easy-to-use static site generator +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! -![image](image.gif) +- **Easy** to use +- Create site content with **Markdown** + +

+ vss +

![CI](https://github.com/zztkm/vss/workflows/CI/badge.svg) @@ -11,10 +17,6 @@ Easy-to-use static site generator 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 @@ -43,11 +45,6 @@ Currently, be sure to configure the following . ├── about.md ├── config.toml -├── dist -│ ├── css -│ │ └── main.css -│ └── js -│ └── main.js ├── index.md ├── layouts │ └── index.html