Skip to main content

My simple static site generator.

Project description

mysgen

test coverage lint type

Python 3.8 - 3.11 Testing framework: pytest Linter and formatter: ruff Type checker: mypy

A very simple static site generator used for mladen.gibanica.net built using Python and Jinja2.

The configuration file config.json should contain the following

{
    "author": "Name",
    "sitename": "Site name",
    "siteurl": "https://address.com",
    "timezone": "Europe/Stockholm",
    "default_lang": "en-gb",
    "theme_path": "path_to_theme",
    "src_path": "path_to_content",
    "build_path": "path_to_build",
    "home": "home",
    "menuitems": {
        "home": "",
        "archive": "archive"
    },
    "post_url": "{{post_url}}",
    "build_date_template": "{{update_date}}",
    "thumbnail_size": [300, 300],
    "markdown_extensions": [
        "meta",
        "fenced_code",
        "mdx_math"
    ],
    "s3-bucket": "bucket",
    "mangle_image_name": true
}

Such a configuration assumes the following folder structure

root/
├─ config.json
├─ path_to_content/
│  ├─ data/
│  ├─ images/
│  ├─ pages/
│  │  ├─ home.md
│  │  ├─ archive.md
│  ├─ posts/
├─ path_to_theme/
│  ├─ css/
│  ├─ js/
│  ├─ templates/
├─ path_to_build/

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

mysgen-0.4.4.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

mysgen-0.4.4-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file mysgen-0.4.4.tar.gz.

File metadata

  • Download URL: mysgen-0.4.4.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for mysgen-0.4.4.tar.gz
Algorithm Hash digest
SHA256 a171f42e8419259f857317c89532bc904b299f0458c5756c72807d9b07e42e6e
MD5 ad8a00e4531a644ea1fe2f2334e9d8af
BLAKE2b-256 ca0dce3eb2c023114a72d643b6b1117ed72794800d1459cc35852c60fe16e9f3

See more details on using hashes here.

File details

Details for the file mysgen-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: mysgen-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for mysgen-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 119a381900f87ca7b1b69bee968d76c82fdca3532276db278d61363f541f9238
MD5 04ee08e9726dd6a2bb1d869791bd78c6
BLAKE2b-256 c386580da0389aa0db2a9ffd299457d7d968195d01e12db0d8aff25735306467

See more details on using hashes here.

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