Socket
Socket
Sign inDemoInstall

alloypress

Package Overview
Dependencies
4
Maintainers
1
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

    alloypress

HTML/CSS-only Python SSG with support for LaTeX, syntax highlighting and sidenotes.


Maintainers
1

Readme

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

FAQs


Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc