HTML/CSS-only Python SSG with support for LaTeX, syntax highlighting and sidenotes.
Project description
alloypress
A Python static site generator which I use for my personal website.
Made using the Python Packaging User Guide.
Getting Started
Install via pip install alloypress
.
Run the following Python code in the root directory of your site:
from alloypress import StaticSite
ssg = StaticSite()
ssg.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 via
markdown
- LaTeX via
latex2mathml
inside$
and$$
delimiters - Syntax highlighting for Python via
pygments
- Sidenotes which are displayed inline on narrow devices
- Sortable and tag-filtered index page for each top-level folder
- Only re-generates HTML if the Markdown has been modified, and deletes orphaned HTML files
To Be Implemented
- Support for other languages via
pygments
- Sidebar-based navigation
- Embedding-based search across all pages
- Post summaries on the index page via yaml frontmatter
- More coming soon...
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
alloypress-0.1.4.tar.gz
(4.3 MB
view hashes)
Built Distribution
Close
Hashes for alloypress-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2402a0653ecf3fa416b3660129c5287882ad5719154948e733c1eda5b2c83a9d |
|
MD5 | 1f3675c51175722309214e625627a90a |
|
BLAKE2b-256 | 2e73173ea96cd9d92401afaeb2d16d00a359d5abde9d77f35c099e59c672df72 |