Git Product home page Git Product logo

yacho's Introduction

yacho

Latest PyPI version Latest Travis CI build status

The static site generator for creative coders.

Demo page

Requirements

  • Python 3.7+

Installation

pip install yacho

Usage

Directory Structure

.
│  avatar.png
│  custom.css
│  yacho.sketchbook.toml    <----------- Put PROJECT config file
│
├─sketch_210401a
│  │  sketch_210401a.pde
│  │  yacho.sketch.toml    <----------- Put sketch config file
│  │
│  ├─cover
│  │      cover_image.png
│  │
│  └─images
│          img1.png
│          img2.png
│          img3.png
│          ...
│
└─sketch_210402a
    │  sketch_210402a.pde
    │  yacho.sketch.toml    <----------- Put sketch config file
    │
    ├─cover
    │      cover_image.png
    │
    └─images
            img1.png
            img2.png
            img3.png
            ...

Build site

# v0.0.2+
yacho build

# v0.0.1
# yacho yacho.sketchbook.toml

Push dist to your gh-pages.

Sketch generator

Processing sketch

yacho create

p5.js sketch

yacho create -t p5js

Example yacho.sketchbook.toml

sketchbook_root = '.'

base_url = 'https://yacho-demo.netlify.app/'

# Page title
title = 'My Sketchbook'

# 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

# If title is empty, sketch dir name will be used as title.
title = "Flowers"

# Default to false
draft = false

comment = "An example comment."

# Files listed in this value will be public.
# Default to:
public = ['*.pde', 'sketch.js', '*.py']

# video embedding will be available v0.0.2
[video]
# Please set 'none', 'youtube', 'vimeo', 'neort' or 'gif'
type = 'none'

# If you use 'gif', id will be interpreted as file path of gif animation.
id = ''

yacho's People

Contributors

eqs avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

theemack

yacho's Issues

Sub command

Sketchbookつくる

yacho create sketchbook

Sketchつくる

yacho create sketch

オプションつき

yacho create sketch --name spam --type pyof

ビルドする

yacho build

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.