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 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 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

To Be Implemented

  • Clearing old files before generating new ones
  • 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.3.tar.gz (4.3 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.3-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: alloypress-0.1.3.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for alloypress-0.1.3.tar.gz
Algorithm Hash digest
SHA256 3789a8a4c94edc4cf411c56687b516f8aee0a13e5ca5ad1c0c788be6f2df55e5
MD5 fc9796a9d0d150e0c490ec08e3e840f1
BLAKE2b-256 6e25e3813bcff8ffe0d62d73250a8cec375f0cb84058b893d5d81de2e6d45a7b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: alloypress-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for alloypress-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 12f2b79f6f0bdfa0df3d7f7101a42db8ea48b03354e1b6e748276ea211c33f79
MD5 a7e94debd73041272230cb4c001cddd1
BLAKE2b-256 67537613e8319dfe6bcbaec056ea02e5389c0dabdca1c03a3de1c4756e8454cc

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