Metadata-Version: 2.1
Name: alloypress
Version: 0.1.0
Summary: HTML/CSS-only Python SSG with support for LaTeX, syntax highlighting and sidenotes.
Project-URL: Homepage, https://github.com/tmychow/alloypress
Author-email: Trevor Chow <tmychow@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: latex2mathml
Requires-Dist: markdown
Requires-Dist: pygments
Requires-Dist: pyyaml
Description-Content-Type: text/markdown

# alloypress

A Python static site generator which I use for [my personal website](https://tmychow.com).

## Getting Started

Install via `pip install alloypress`.

Run the following Python code in the root directory of your site:

```
from alloypress import generate
generate()
```

An example of this can be seen in `./tests`. It will take every `.md` file in `./raw` and generate the HTML in `./`.

## Features 

The high-level approach of `alloypress` is serve static HTML and CSS files, rendering nothing client-side.

It supports:

- Jon Gruber's original [Markdown syntax](https://daringfireball.net/projects/markdown/syntax) via `markdown`
- LaTeX via `latex2mathml` inside `$` and `$$` delimiters
- Syntax highlighting for Python via `pygments`
- Sidenotes which are displayed inline on narrow devices
- Automatic generation of an index page for each top-level folder

## To Be Implemented

- [ ] Filtering by tags for posts in the index page
- [ ] Clearing old files before generating new ones
- [ ] Support for other languages via `pygments`
- [ ] Sidebar-based navigation
- [ ] Embedding-based search across all pages
- [ ] More coming soon...