Skip to main content

A Static Site Generator using markdown files

Project description

# pyssg

Static Site Generator inspired by Roman Zolotarev’s [ssg5](https://rgz.ee/bin/ssg5) and [rssg](https://rgz.ee/bin/rssg), Luke Smith’s [lb and sup](https://github.com/LukeSmithxyz/lb) and, pedantic.software’s [blogit](https://pedantic.software/git/blogit/).

The reason of making this in python is because I was tired of wanting (some) features from all of these minimal programs, but being a pain in the ass to maintain or add features on my own, specially to blogit…; making minimalist software it’s great and all, but there is a limit on how pretentious and elitist a software can be for me to accept it.

## Current features

This is still a WIP. Still doesn’t build sitemap.xml or rss.xml files.

  • [x] Build static site parsing markdown files ( *.md -> *.html)
    • [x] Preserves hand-made *.html files.

    • [x] Tag functionality.

    • [ ] Open Graph (and similar) support.

  • [ ] Build sitemap.xml file.

  • [ ] Build rss.xml file.

## Markdown features

This program uses [python-markdown](https://python-markdown.github.io/) package with the following [extensions](https://python-markdown.github.io/extensions/):

  • Extra (collection of QoL extensions).

  • Meta-Data.

  • Sane Lists.

  • SmartyPants.

  • Table of Contents.

  • WikiLinks.

## Usage

First initialize the directories you’re going to use for the source files and destination files:

`sh pyssg -s src_dir -d dst_dir -i `

That creates the desired directories with the basic templates that can be edited as desired. Place your *.md files somewhere inside the source directory (src_dir in the command above), but outside of the templates directory. It accepts sub-directories.

Build the site with:

`sh pyssg -s src_dir -d dst_dir -b `

That creates all *.html for the site and can be easily moved to the server. Where an optional -u flag can be provided for the base URL (don’t include the trailing slash /)

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

pyssg-0.2.2.tar.gz (22.6 kB view hashes)

Uploaded Source

Built Distribution

pyssg-0.2.2-py3-none-any.whl (23.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page