Skip to main content

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.5.tar.gz (4.4 MB view details)

Uploaded Source

Built Distribution

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

alloypress-0.1.5-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file alloypress-0.1.5.tar.gz.

File metadata

  • Download URL: alloypress-0.1.5.tar.gz
  • Upload date:
  • Size: 4.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for alloypress-0.1.5.tar.gz
Algorithm Hash digest
SHA256 db2f778a58508cbb84ed6cc71f996e0fed5403ae6852804778a5ae2eb1b2b4ff
MD5 9f42998c3a59220ddade7bc74e9804bc
BLAKE2b-256 054ed8f34bb4c7bfc8f8025a0c4acbb6117c9b00ea5fa0c7ddb7ccd156ae2458

See more details on using hashes here.

File details

Details for the file alloypress-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: alloypress-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for alloypress-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 044b9c9e42d43dfa55d6dabcb1e92d19ab37389b0b47706ed1d311dfcbe75f43
MD5 e2099d40d3e18196ab7241131805780f
BLAKE2b-256 b791202c800f46195dbed1aa41e6677cc81950c31fd1ae4b60ad9ad5cc75fc18

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