📝 update readme for v0.0.6

2 years ago · 4fe9745817
parent 283874fded
commit 4fe9745817
1 changed files with 36 additions and 14 deletions
--- a/README.md
+++ b/README.md
@ -26,12 +26,22 @@ Currently, be sure to configure the following
 ```
 ❯ tree  
 .
+├── about.md
 ├── config.toml
 ├── dist
-│   └── index.html
+│   ├── css
+│   │   └── main.css
+│   └── js
+│       └── main.js
 ├── index.md
-└── layouts
-    └── _index.html
+├── layouts
+│   └── index.html
+└── static
+    ├── css
+    │   └── main.css
+    └── js
+        └── main.js
+
 ```

 ❯ cat index.md
@ -41,21 +51,28 @@ Currently, be sure to configure the following
 A static site generator

 - [GitHub](https://github.com/zztkm)
+
+[about page](./about.md)
 ```

 ❯ cat config.toml 
 ```toml
 title = "Open Sea"
+description = "Takumi Tsuruta's home page"
+baseUrl = 'https://zztkm.github.io/vss/'
 ```

-❯ cat layouts/_index.html 
+❯ cat layouts/index.html 
 ```html
 <!DOCTYPE html>

 <head>
    <meta charset="utf-8">
    <title>@title</title>
+    <base href="@baseUrl">
+    <meta name="description" content="@description" />
 </head>
+
 <body>
    @contents
 </body>
@ -63,18 +80,19 @@ title = "Open Sea"

 Build your site
 ```
-vss
+vss build
 ```

-### Output
-
+Output
 ```
-❯ tree
-.
-├── dist
-│   └── index.html
-├── index.md
-└── vss
+❯ tree dist
+dist
+├── about.html
+├── css
+│   └── main.css
+├── index.html
+└── js
+    └── main.js
 ```

 ❯ cat dist/index.html 
@ -83,13 +101,17 @@ vss

 <head>
    <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>
+
 <body>
    <h1>Open Sea</h1>
 <p>A static site generator</p>
 <ul>
 <li><a href="https://github.com/zztkm">GitHub</a></li>
 </ul>
+<p><a href="./about.html">about page</a></p>
 </body>
 ```