Skip to main content

A Pyblosxom entryparser plugin that uses Markdown syntax and parses the whole file as the entry body

Project description

# pyblosxomsimplemarkdown

pyblosxomsimplemarkdown is a [PyBlosxom](https://pyblosxom.github.io/)
entryparser plugin that lets you write your entries in
[Markdown](http://daringfireball.net/projects/markdown/). Specifically,
[Python Markdown](https://pythonhosted.org/Markdown/) is used.

pyblosxomsimplemarkdown differs from other PyBlosxom Markdown plugins in that
it treats the entire contents of the entry file as just the entry body.
Normally PyBlosxom treats the first line of an entry as its title, any
following lines that start with `#` as metadata, and the rest of the file as
the entry's body:

This is the title
#key value
#foo bar

The rest of the file is the Markdown-formatted entry body...

pyblosxomsimplemarkdown just treats the entire contents of the file as a
Markdown-formatted body. The entry dict won't have any value in its 'title'
field. If you want to write a traditional blog post with a title and body, just
insert the title yourself:

# This is the title

This is the contents...

If you want to create a differently-formatted post that doesn't start with a
title, such as a link, a quote or an image with a caption, just go ahead and
write that in Markdown.

pyblosxom-markdown currently parses entries with the filename extensions '.md'
and '.markdown' (these are currently hardcoded and not configurable).

pyblosxom-markdown currently uses Python Markdown's
[Extra](https://pythonhosted.org/Markdown/extensions/extra.html) and
[SmartyPants](https://pythonhosted.org/Markdown/extensions/smarty.html) plugins
(hardcoded, not configurable).

pyblosxom-markdown renders entries as HTML5 (hardcoded, not configurable).


## Installation

Install the pyblosxomsimplemarkdown package from pip:

pip install pyblosxomsimplemarkdown

Then add it to the `load_plugins` setting in your `config.py`:

py["load_plugins"] = [
'pyblosxomsimplemarkdown.simplemarkdown',
]

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

pyblosxomsimplemarkdown-0.0.1.tar.gz (3.7 kB view details)

Uploaded Source

File details

Details for the file pyblosxomsimplemarkdown-0.0.1.tar.gz.

File metadata

File hashes

Hashes for pyblosxomsimplemarkdown-0.0.1.tar.gz
Algorithm Hash digest
SHA256 7d2a01e0c8333991b8a252311be12468cefcb3f82f484ab8baab8562cac9a5ad
MD5 2df29a9f02e20b08070f43ef686e5ab5
BLAKE2b-256 5c19bfbd77ac60f61138e35560946d89fd2c6adb89a60db087005ff167c173d7

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