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

📝 update readme for v0.0.6

Browse source
This commit is contained in:
zztkm 2022-08-12 22:17:10 +09:00
parent 283874fded
commit 4fe9745817
1 changed files with 36 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -26,12 +26,22 @@ Currently, be sure to configure the following
``` ```
❯ tree ❯ tree
. .
├── about.md
├── config.toml ├── config.toml
├── dist ├── dist
│ └── index.html │ ├── css
│ │ └── main.css
│ └── js
│ └── main.js
├── index.md ├── index.md
└── layouts ├── layouts
└── _index.html │ └── index.html
└── static
├── css
│ └── main.css
└── js
└── main.js
``` ```
❯ cat index.md ❯ cat index.md
@ -41,21 +51,28 @@ Currently, be sure to configure the following
A static site generator A static site generator
- [GitHub](https://github.com/zztkm) - [GitHub](https://github.com/zztkm)
[about page](./about.md)
``` ```
❯ cat config.toml ❯ cat config.toml
```toml ```toml
title = "Open Sea" title = "Open Sea"
description = "Takumi Tsuruta's home page"
baseUrl = 'https://zztkm.github.io/vss/'
``` ```
❯ cat layouts/_index.html ❯ cat layouts/index.html
```html ```html
<!DOCTYPE html> <!DOCTYPE html>
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>@title</title> <title>@title</title>
<base href="@baseUrl">
<meta name="description" content="@description" />
</head> </head>
<body> <body>
@contents @contents
</body> </body>
@ -63,18 +80,19 @@ title = "Open Sea"
Build your site Build your site
``` ```
vss vss build
``` ```
### Output Output
``` ```
❯ tree ❯ tree dist
. dist
├── dist ├── about.html
│ └── index.html ├── css
├── index.md │ └── main.css
└── vss ├── index.html
└── js
└── main.js
``` ```
❯ cat dist/index.html ❯ cat dist/index.html
@ -83,13 +101,17 @@ vss
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>tsurutatakumi.info</title> <title>Open Sea</title>
<base href="https://zztkm.github.io/vss/">
<meta name="description" content="Takumi Tsuruta's home page" />
</head> </head>
<body> <body>
<h1>Open Sea</h1> <h1>Open Sea</h1>
<p>A static site generator</p> <p>A static site generator</p>
<ul> <ul>
<li><a href="https://github.com/zztkm">GitHub</a></li> <li><a href="https://github.com/zztkm">GitHub</a></li>
</ul> </ul>
<p><a href="./about.html">about page</a></p>
</body> </body>
``` ```