Add your description here
Project description
air
An ultra-lightweight static site generator created by https://audrey.feldroy.com.
- Project homepage and documentation: https://air.feldroy.com
- GitHub repo: https://github.com/feldroy/air
- PyPI package: https://pypi.org/project/air/
Quickstart
First, create a directory for your site, initialize it with Rye, and add the air package. Replace example.com with the name of your site:
mkdir example.com
cd example.com
rye init
rye add air
Then create an input directory and add some templates:
touch input/base.html input/index.html
Put the following content in input/base.html:
<!DOCTYPE html>
<html>
<body>
{% block content %}{% endblock %}
</body>
</html>
And put the following content in input/index.html:
{% extends "base.html" %}
{% block content %}
<h1>Hello, world!</h1>
{% endblock %}
Then run the air command:
rye run air
The generated site will be in the public directory.
Using Markdown
Put the following content in input/hello.md:
---
title: Home
---
# Hello, world!
Then run the air command:
rye run air
The generated site will be in the public directory, with a hello.html page generated from the hello.md file.
Deploying to GitHub Pages
First, create a repository on GitHub with your site's domain name as the repository name, e.g. example.github.io
Enable GitHub Pages: In your repository, go to "Settings" > "Pages" and set:
- Source: Deploy from a branch
- Branch: main
- Folder: / (root)
Click "Save".
Commit and push your HTML files to the main branch.
Set up your custom domain per GitHub's instructions.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file air-0.3.0.tar.gz.
File metadata
- Download URL: air-0.3.0.tar.gz
- Upload date:
- Size: 4.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7800891b8a47f480e0d0c9355c67ab0ec1c24792daff97dd65eff1a14a14aa12 |
|
| MD5 | a8bcbc0393b3696f62fae767d40ed09f |
|
| BLAKE2b-256 | 295358a407edb159de09c7ec792ebeb7c18d09afac23f392016a3365583f5611 |
File details
Details for the file air-0.3.0-py3-none-any.whl.
File metadata
- Download URL: air-0.3.0-py3-none-any.whl
- Upload date:
- Size: 3.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 58b0ffec6f3e4c5e3a09eb82320a3738da591061dc9ad229cbf7fff957df716d |
|
| MD5 | ec0723d8e3d0ff2458c7d6e2d7abf559 |
|
| BLAKE2b-256 | 5eaf2435e38ed112b7e2b2606cbf7ff85daba3ee7a425313cb78b1b46a9a5b4b |
