Metadata-Version: 2.4
Name: arcade-generator
Version: 0.12.0
Summary: A static site generator
Author-email: Yabir Benchakhtir <yabirg@protonmail.com>
License: MIT
License-File: LICENSE
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.12
Requires-Dist: click==8.3.1
Requires-Dist: jinja2==3.1.6
Requires-Dist: livereload==2.7.1
Requires-Dist: markdown==3.10
Description-Content-Type: text/markdown

# 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

```
uv tool install arcade-generator
arcade --help
```

If you prefer a project install:

```
uv pip install arcade-generator
```

## Commands

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

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

## Development

Install dev dependencies and run tests:

```
uv sync --group dev
uv run pytest
```

Lint and type-check:

```
uv run ruff check .
uv run ty check .
```


## How to use

1. Create a new project

```
arcade init
```

2. Modify the `arcade.toml` configuration file. An example is 

```
author_name = "Yabir Garcia 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" }
```

Notes:
- `base_path` is used to build absolute URLs in the Atom feed.
- `theme` should point to a theme directory that contains the templates and `static/` assets.

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)
