📝 update readme

main
zztkm 2 years ago
parent 34a26861e2
commit 309125fd03

@ -1,6 +1,8 @@
# vss # vss
A static site generator Easy-to-use static site generator
![CI](https://github.com/zztkm/vss/workflows/CI/badge.svg)
## Caution ## Caution
@ -9,16 +11,23 @@ Be aware that destructive changes will be made if you use it!
## Feature ## Feature
- Create site content with markdown
- Easy to use - Easy to use
- Create site content with markdown
## Installation
## Install ### Get the binary
Download from [Releases](https://github.com/zztkm/vss/releases)
### Build from source
``` ```
git clone https://github.com/zztkm/vss.git git clone https://github.com/zztkm/vss.git
cd vss cd vss
v vss.v v install markdown
v . -o vss
``` ```
## Usage ## Usage
@ -118,4 +127,8 @@ dist
</ul> </ul>
<p><a href="./about.html">about page</a></p> <p><a href="./about.html">about page</a></p>
</body> </body>
``` ```
## Example
Examples can be found at the [example](https://github.com/zztkm/vss/tree/main/example) directory.

Loading…
Cancel
Save