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

📝 update: readme.md

Browse source
This commit is contained in:
zztkm 2022-07-31 20:25:50 +09:00
parent 315baaf552
commit 6f056318be
1 changed files with 33 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -19,20 +19,46 @@ v vss.v
## Usage ## Usage
Setup contents ### Setup contents
Currently, be sure to configure the following
``` ```
❯ tree ❯ tree
. .
├── config.toml
├── dist
│ └── index.html
├── index.md ├── index.md
└── vss (executable) └── layouts
└── _index.html
```
❯ cat index.md ❯ cat index.md
```markdown
# Open Sea # Open Sea
A static site generator A static site generator
- [GitHub](https://github.com/zztkm) - [GitHub](https://github.com/zztkm)
```
❯ cat config.toml
```toml
title = "Open Sea"
```
❯ cat layouts/_index.html
```html
<!DOCTYPE html>
<head>
<meta charset="utf-8">
<title>@title</title>
</head>
<body>
@contents
</body>
``` ```
Build your site Build your site
@ -40,7 +66,8 @@ Build your site
vss vss
``` ```
Output ### Output
``` ```
❯ tree ❯ tree
. .
@ -48,10 +75,10 @@ Output
│ └── index.html │ └── index.html
├── index.md ├── index.md
└── vss └── vss
```
1 directory, 3 files
❯ cat dist/index.html ❯ cat dist/index.html
```html
<!DOCTYPE html> <!DOCTYPE html>
<head> <head>