Skip to main content

A static site generator

Project description

arcade

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
  1. 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.
  1. Create a index file

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

  1. Build or watch your project
arcade build
arcade watch

Themes

Currently only the baseline theme is available. You can download it here

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

Credit

Photo by @hartmuttobies

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arcade_generator-0.12.0.tar.gz (547.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arcade_generator-0.12.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file arcade_generator-0.12.0.tar.gz.

File metadata

  • Download URL: arcade_generator-0.12.0.tar.gz
  • Upload date:
  • Size: 547.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.24 {"installer":{"name":"uv","version":"0.9.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for arcade_generator-0.12.0.tar.gz
Algorithm Hash digest
SHA256 c3d115c110fc6cdc5a03632631b7ebb381269fd4c29cbfac754973899c98ef35
MD5 974d8ecfad092ad14bb679d25f1cc750
BLAKE2b-256 8381546c4c2260c40fd66a27fe5a3b7e168d4da5b5f7a20defdecc022a61c919

See more details on using hashes here.

File details

Details for the file arcade_generator-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: arcade_generator-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.24 {"installer":{"name":"uv","version":"0.9.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for arcade_generator-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45c09222ccccba4224cda58b0d728f4195860452e1d112b8803131e451b17f0e
MD5 69dc76b727c7f70e205f5bcfd1a8e20c
BLAKE2b-256 3cc863477e3a855adb54a09deb2e074971512eb1be63fb038229a78d443c1fcc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page