📝 update: readme.md

main
zztkm 2 years ago
parent 315baaf552
commit 6f056318be

@ -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>

Loading…
Cancel
Save