From 6f056318be2bbba7c7e6aedb2ec7a63ca33e62e7 Mon Sep 17 00:00:00 2001 From: zztkm Date: Sun, 31 Jul 2022 20:25:50 +0900 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20update:=20readme.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2f84bc7..a262caa 100644 --- a/README.md +++ b/README.md @@ -19,20 +19,46 @@ v vss.v ## Usage -Setup contents +### Setup contents + +Currently, be sure to configure the following + ``` -❯ tree +❯ tree . +├── config.toml +├── dist +│ └── index.html ├── index.md -└── vss (executable) +└── layouts + └── _index.html +``` ❯ cat index.md +```markdown # Open Sea A static site generator - [GitHub](https://github.com/zztkm) +``` +❯ cat config.toml +```toml +title = "Open Sea" +``` + +❯ cat layouts/_index.html +```html + + + + + @title + + + @contents + ``` Build your site @@ -40,7 +66,8 @@ Build your site vss ``` -Output +### Output + ``` ❯ tree . @@ -48,10 +75,10 @@ Output │ └── index.html ├── index.md └── vss - -1 directory, 3 files +``` ❯ cat dist/index.html +```html