Metadata-Version: 2.1
Name: arcade-generator
Version: 0.11
Summary: A static site generator
Author-email: Yabir Benchakhtir <yabirg@proton.me>
License: MIT License
        
        Copyright (c) 2019 Yábir Benchakhtir
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jinja2>=3
Requires-Dist: markdown>=3.2.1
Requires-Dist: click>=7.1.1
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: livereload>=2.6.1

# arcade

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

Yet another static site generator. 

## Features

- Theme customization (templates use `jinja2`)
- Live reload while editing
- Customizable paths

## Installation

```
pip install arcade-generator
```

## 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
```

## Themes

Currently only the baseline theme is available. You can download it [here](https://github.com/yabirgb/arcade/releases/download/0.0.5/baseline.zip)

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

## Credit

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