From 6315e1414b582a298176feba69bbc5c8012d0b3c Mon Sep 17 00:00:00 2001 From: eqs Date: Wed, 21 Apr 2021 17:50:19 +0900 Subject: [PATCH 1/4] Add docs --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 56 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6c8de03..48cfd58 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,65 @@ yacho [![Latest PyPI version](https://img.shields.io/pypi/v/yacho.svg)](https://pypi.python.org/pypi/yacho) [![Latest Travis CI build status](https://travis-ci.com/eqs/yacho.png)](https://travis-ci.com/eqs/yacho) -## Usage +## Requirements + +* Python 3.7+ ## Installation -## Requirements +``` +pip install git+https://github.com/eqs/yacho.git@v0.0.1 +``` + +## Usage + +### Directory Structure + +### Build site + +``` +yacho yacho.sketchbook.toml +``` + +## Example + +* Demo page: https://yacho-demo.netlify.app/ +* Repository: https://github.com/eqs/yacho-example + +### Example `yacho.sketchbook.toml` + +```toml +sketchbook_root = '.' + +base_url = 'https://yacho-demo.netlify.app/' + +# Profile information +author = 'eqs' +avatar = 'chi.png' # relative path from sketchbook_root +bio = """ +Creative Coder +""" + +# Your custom css (relative path from sketchbook_root) +custom_css = 'custom.css' + +[social] +home = "https://www.eqseqs.work" +twitter = "eqs_work" +github = "eqs" +instagram = "" +youtube = "" +facebook = "" +``` + +### Example `yacho.sketch.toml` -## Licence +```toml +# If title is empty, sketch dir name will be used as title. +title = "Flowers" -## Authors +# Default to false +draft = false -eqs ( `murashige.satoshi.mi1 [at] gmail.com` ) +comment = "An example comment." +``` From 01fc39186249839faddd799a0044f354953b797e Mon Sep 17 00:00:00 2001 From: eqs Date: Wed, 21 Apr 2021 17:59:00 +0900 Subject: [PATCH 2/4] Add dir structure --- README.md | 43 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 38 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 48cfd58..cb879f6 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ yacho [![Latest PyPI version](https://img.shields.io/pypi/v/yacho.svg)](https://pypi.python.org/pypi/yacho) [![Latest Travis CI build status](https://travis-ci.com/eqs/yacho.png)](https://travis-ci.com/eqs/yacho) +## Demo page + +* Demo page: https://yacho-demo.netlify.app/ +* Repository: https://github.com/eqs/yacho-example + ## Requirements * Python 3.7+ @@ -19,17 +24,45 @@ pip install git+https://github.com/eqs/yacho.git@v0.0.1 ### Directory Structure +``` +. +│ avatar.png +│ custom.css +│ yacho.sketchbook.toml +│ +├─sketch_210401a +│ │ sketch_210401a.pde +│ │ yacho.sketch.toml +│ │ +│ ├─cover +│ │ cover_image.png +│ │ +│ └─images +│ img1.png +│ img2.png +│ img3.png +│ ... +│ +└─sketch_210402a + │ sketch_210402a.pde + │ yacho.sketch.toml + │ + ├─cover + │ cover_image.png + │ + └─images + img1.png + img2.png + img3.png + ... +``` + ### Build site ``` yacho yacho.sketchbook.toml ``` -## Example - -* Demo page: https://yacho-demo.netlify.app/ -* Repository: https://github.com/eqs/yacho-example - ### Example `yacho.sketchbook.toml` ```toml From 66b08102c24b2907fbebb9b6887a4313beabff95 Mon Sep 17 00:00:00 2001 From: eqs Date: Wed, 21 Apr 2021 18:03:30 +0900 Subject: [PATCH 3/4] ^_^ --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cb879f6..6f706fc 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # yacho -yacho - [![Latest PyPI version](https://img.shields.io/pypi/v/yacho.svg)](https://pypi.python.org/pypi/yacho) [![Latest Travis CI build status](https://travis-ci.com/eqs/yacho.png)](https://travis-ci.com/eqs/yacho) +The static site generator for creative coders. + ## Demo page * Demo page: https://yacho-demo.netlify.app/ @@ -28,11 +28,11 @@ pip install git+https://github.com/eqs/yacho.git@v0.0.1 . │ avatar.png │ custom.css -│ yacho.sketchbook.toml +│ yacho.sketchbook.toml <----------- Put PROJECT config file │ ├─sketch_210401a │ │ sketch_210401a.pde -│ │ yacho.sketch.toml +│ │ yacho.sketch.toml <----------- Put sketch config file │ │ │ ├─cover │ │ cover_image.png @@ -45,7 +45,7 @@ pip install git+https://github.com/eqs/yacho.git@v0.0.1 │ └─sketch_210402a │ sketch_210402a.pde - │ yacho.sketch.toml + │ yacho.sketch.toml <----------- Put sketch config file │ ├─cover │ cover_image.png From b1d6e47629987039ac60ff9bfb3cfde1dbd6821b Mon Sep 17 00:00:00 2001 From: eqs Date: Wed, 21 Apr 2021 18:04:48 +0900 Subject: [PATCH 4/4] gh-pages --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6f706fc..29dd76a 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,8 @@ pip install git+https://github.com/eqs/yacho.git@v0.0.1 yacho yacho.sketchbook.toml ``` +Push `dist` to your gh-pages. + ### Example `yacho.sketchbook.toml` ```toml