Metadata-Version: 2.1
Name: arcade-generator
Version: 0.0.3
Summary: A static blog generator
Home-page: https://github.com/yabirgb/arcade
Author: Yábir Benchakhtir
Author-email: yabirg@protonmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: click (==7.0)
Requires-Dist: jinja2 (==2.10.3)
Requires-Dist: livereload (==2.6.1)
Requires-Dist: markdown (==3.1.1)
Requires-Dist: markupsafe (==1.1.1)
Requires-Dist: pygments (==2.4.2)
Requires-Dist: pyyaml (==5.1.2)
Requires-Dist: six (==1.12.0)
Requires-Dist: tornado (==6.0.3)

# arcade

![](assets/hartmut-tobies-O9TEKuI1Icw-unsplash-min.jpg)

Yet another static site generator. 

## Porpouse

The porpouse in life for this project is to create a cool static site for my blog.

**Being developed**

## Features

- Theme customization
- Live reload while editing
- Customizable paths


## Commands

- Create a new site
```
arcade init
```

- Compile your site
```
arcade build
```   
- Watch local project
```
arcade watch
```


## How to use

1. Create a new project

```
arcade init
```

2. Modify the configuration file. An example is 

```
author_name: 'Yábir García Benchakhtir'
base_path: 'http://localhost:5500'
page_name: "Yabir Garcia's Blog"
theme: 'themes/baseline'
social:
  email:
    icon: 'fa-envelope'
    url: 'mailto:yabirg@protonmail.com'
  github:
    icon: 'fa-github'
    url: 'https://github.com/yabirgb'
  linkedin:
    icon: 'fa-linkedin-square'
    url: 'https://www.linkedin.com/in/yabirgb/'
  mastodon:
    icon: 'fa-mastodon'
    url: 'https://mstdn.io/@yabirgb'
  twitter:
    icon: 'fa-twitter'
    url: 'https://twitter.com/yabirgb'
```

3. Create a index file

Go to the `content` and create an file called `index.md`. This will
be the entry point to your blog

4. Build or watch your project

```
arcade build
arcade watch
```

Made with :heart: and :snake: by Yábir Benchakhtir

## Credit

Photo by [@hartmuttobies](https://unsplash.com/@hartmuttobies)


