n/vss
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

📝 udpate caution msg

Browse source
This commit is contained in:
zztkm 2022-09-06 01:03:33 +09:00
parent 700a4dfbec
commit 9612ccfb2d
1 changed files with 16 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,7 +1,7 @@
# vss # vss
vss is an easy to use static site generator. vss is an easy to use static site generator. With `layout/index.html`, Markdown
With `layout/index.html`, Markdown content, and a little configuration, you can easily build your website! content, and a little configuration, you can easily build your website!
- **Easy** to use - **Easy** to use
- Create site content with **Markdown** - Create site content with **Markdown**
@ -14,13 +14,13 @@ With `layout/index.html`, Markdown content, and a little configuration, you can
## Caution ## Caution
vss is still under development and the API is not stable. vss is still under development and the API is not stable. Be aware that
Be aware that destructive changes will be made if you use it! disruptive changes may be made!
## Installation ## Installation
### Get the binary ### Get the binary
Download from [Releases](https://github.com/zztkm/vss/releases) Download from [Releases](https://github.com/zztkm/vss/releases)
### Build from source ### Build from source
@ -53,10 +53,10 @@ Currently, be sure to configure the following
│ └── main.css │ └── main.css
└── js └── js
└── main.js └── main.js
``` ```
❯ cat index.md ❯ cat index.md
```markdown ```markdown
# Open Sea # Open Sea
@ -68,6 +68,7 @@ A static site generator
``` ```
❯ cat config.toml ❯ cat config.toml
```toml ```toml
title = "Open Sea" title = "Open Sea"
description = "Takumi Tsuruta's home page" description = "Takumi Tsuruta's home page"
@ -75,6 +76,7 @@ baseUrl = 'https://zztkm.github.io/vss/'
``` ```
❯ cat layouts/index.html ❯ cat layouts/index.html
```html ```html
<!DOCTYPE html> <!DOCTYPE html>
@ -91,11 +93,13 @@ baseUrl = 'https://zztkm.github.io/vss/'
``` ```
Build your site Build your site
``` ```
vss build vss build
``` ```
Output Output
``` ```
❯ tree dist ❯ tree dist
dist dist
@ -108,6 +112,7 @@ dist
``` ```
❯ cat dist/index.html ❯ cat dist/index.html
```html ```html
<!DOCTYPE html> <!DOCTYPE html>
@ -130,4 +135,5 @@ dist
## Example ## Example
Examples can be found at the [example](https://github.com/zztkm/vss/tree/main/example) directory. Examples can be found at the
[example](https://github.com/zztkm/vss/tree/main/example) directory.