Skip to main content

static site generator built on pandoc + jinja2

Project description

PyPI PyPI - Downloads docs

Checks Checks - docs Coverage

GitHub commits GitHub commit activity GitHub closed pull requests code size, bytes

pdj_sitegen

**Pand**oc and **J**inja Site **Gen**erator

Installation:

pip install pdj-sitegen

you should either have Pandoc installed, or you can run

python -m pdj_sitegen.install_pandoc

which will install pandoc using pypandoc

Usage

  1. create a config file. For an example, see pdj_sitegen.config.DEFAULT_CONFIG_YAML, or print a copy of it via
python -m pdj_sitegen.config
  1. adjust the config file to your needs. most importantly:
# directory with markdown content files and resources, relative to cwd
content_dir: content/
# directory with resources, relative to `content_dir`
resources_dir: resources/
# templates directory, relative to cwd
templates_dir: templates/
# default template file, relative to `templates_dir`
default_template: default.html.jinja2
# output directory, relative to cwd
output_dir: docs/
  1. populate the content directory with markdown files, populate content/resources/ with resources (images, css, etc.), and adjust templates in the templates directory. See the demo site for usage examples.

  2. run the generator

python -m pdj_sitegen your_config.yaml

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

pdj_sitegen-0.0.2.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

pdj_sitegen-0.0.2-py3-none-any.whl (32.9 kB view details)

Uploaded Python 3

File details

Details for the file pdj_sitegen-0.0.2.tar.gz.

File metadata

  • Download URL: pdj_sitegen-0.0.2.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for pdj_sitegen-0.0.2.tar.gz
Algorithm Hash digest
SHA256 d74f410cc45078e04a4c2dbb7b25d9cb1b2d55f6779b73054bdf0f6891269cd3
MD5 92d9ad4c3134093a409620a69294b82b
BLAKE2b-256 b7e597abf50e2bd897336347916b1cdca1dc00afe68a0a111850df17acddfdec

See more details on using hashes here.

File details

Details for the file pdj_sitegen-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: pdj_sitegen-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 32.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for pdj_sitegen-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 44b0ab34fa290277e2ab5419330acb7a13c76db1fd5c8e8e24519c558361a287
MD5 35ff8cb4d7b60bf18490570bd44bd939
BLAKE2b-256 b82bd9903c1ec9674afb145164c038f9cd9b501e6015e994c43cdf15f09d2ede

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