bloggerer

Name	bloggerer JSON
Version	0.9 JSON
	download
home_page
Summary	Transforms markdown (and probably other things too) into WordPress-compatible "Custom HTML" with pandoc and additional magic.
upload_time	2023-06-27 06:28:49
maintainer
docs_url	None
author
requires_python	>=3.6
license	Copyright (c) 2020-2022 NCC Group, 2023 Jeff Dileo. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords	pandoc panflute markdown wordpress html
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Bloggerer: Markdown (and other things, probably) sprucer upperer

`bloggerer` is a very thin wrapper around a panflute-based Pandoc filter script
that does some preprocessing magic for publishing things as (generally) HTML.
I have mainly used it for generating better-looking and more functional HTML
than WordPress' own Markdown handling, but also for some other quality-of-life
features.

## Usage

```
$ bloggerer path/to/post.md
```

The resulting HTML will be located in `path/to/post.md.html` and can be copied
into a WordPress "Custom HTML" block.

## Features

* Handles footnotes properly
* Proper code-block formatting and syntax highlighting
    * Handled by [`highlight`](<https://gitlab.com/saalen/highlight>)
* Support for inline images
    * WordPress incorrectly considers `data:` URIs to be dangerous in `<img>`
      and CSS `url()`s, `bloggerer` gets around that. (Working in prod for 3+
      years. Caveat emptor, this causes the HTML to blow up and you may run
      into WordPress' or other blogging systems' character limits.)

## Installation

### Prerequisites

```
$ sudo apt-get install pandoc highlight
```

***Note:*** If your distro has an older version of pandoc (e.g. 2.9.x), get it from <https://github.com/jgm/pandoc/releases/>.

```
$ wget https://github.com/jgm/pandoc/releases/download/<ver>/pandoc-<...>.deb
$ sudo dpkg -i ./pandoc-*.deb
```

### Install

```
$ pip3 install --user bloggerer
```

### From Source

```
$ git clone https://github.com/ChaosData/bloggerer && cd bloggerer
$ python3 -m pip install --user --upgrade pip setuptools
$ python3 -m pip install --user .
```

### Packaging

```
$ python3 -m pip install --user wheel build
$ python3 -m build --sdist --wheel .
$ python3 -m pip install --user dist/bloggerer-*.whl
```

### Cleaning

```
$ rm -rf ./build ./dist ./src/bloggerer.egg-info ./src/bloggerer/__pycache__
```

## FAQ

> Why is the first top level heading removed from the HTML?

The first top-level heading is typically the title, which handled by
WordPress or other blogging things.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "bloggerer",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "Jeff Dileo <jtdileo@gmail.com>",
    "keywords": "pandoc,panflute,markdown,wordpress,html",
    "author": "",
    "author_email": "Jeff Dileo <jtdileo@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/a8/03/34e1dc27e1bc5f9709db6391d8a737cf5c73eb3230ceea7c547434d6027d/bloggerer-0.9.tar.gz",
    "platform": null,
    "description": "# Bloggerer: Markdown (and other things, probably) sprucer upperer\n\n`bloggerer` is a very thin wrapper around a panflute-based Pandoc filter script\nthat does some preprocessing magic for publishing things as (generally) HTML.\nI have mainly used it for generating better-looking and more functional HTML\nthan WordPress' own Markdown handling, but also for some other quality-of-life\nfeatures.\n\n## Usage\n\n```\n$ bloggerer path/to/post.md\n```\n\nThe resulting HTML will be located in `path/to/post.md.html` and can be copied\ninto a WordPress \"Custom HTML\" block.\n\n## Features\n\n* Handles footnotes properly\n* Proper code-block formatting and syntax highlighting\n    * Handled by [`highlight`](<https://gitlab.com/saalen/highlight>)\n* Support for inline images\n    * WordPress incorrectly considers `data:` URIs to be dangerous in `<img>`\n      and CSS `url()`s, `bloggerer` gets around that. (Working in prod for 3+\n      years. Caveat emptor, this causes the HTML to blow up and you may run\n      into WordPress' or other blogging systems' character limits.)\n\n## Installation\n\n### Prerequisites\n\n```\n$ sudo apt-get install pandoc highlight\n```\n\n***Note:*** If your distro has an older version of pandoc (e.g. 2.9.x), get it from <https://github.com/jgm/pandoc/releases/>.\n\n```\n$ wget https://github.com/jgm/pandoc/releases/download/<ver>/pandoc-<...>.deb\n$ sudo dpkg -i ./pandoc-*.deb\n```\n\n### Install\n\n```\n$ pip3 install --user bloggerer\n```\n\n### From Source\n\n```\n$ git clone https://github.com/ChaosData/bloggerer && cd bloggerer\n$ python3 -m pip install --user --upgrade pip setuptools\n$ python3 -m pip install --user .\n```\n\n### Packaging\n\n```\n$ python3 -m pip install --user wheel build\n$ python3 -m build --sdist --wheel .\n$ python3 -m pip install --user dist/bloggerer-*.whl\n```\n\n### Cleaning\n\n```\n$ rm -rf ./build ./dist ./src/bloggerer.egg-info ./src/bloggerer/__pycache__\n```\n\n## FAQ\n\n> Why is the first top level heading removed from the HTML?\n\nThe first top-level heading is typically the title, which handled by\nWordPress or other blogging things.\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2020-2022 NCC Group, 2023 Jeff Dileo. All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Transforms markdown (and probably other things too) into WordPress-compatible \"Custom HTML\" with pandoc and additional magic.",
    "version": "0.9",
    "project_urls": {
        "repository": "https://github.com/ChaosData/bloggerer"
    },
    "split_keywords": [
        "pandoc",
        "panflute",
        "markdown",
        "wordpress",
        "html"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6aa07ff690c60f437d65bd8c7e05a98e85eb9c8778d5032a30af47b4744abe8d",
                "md5": "a11f907c52c09c15077a06ff59b7814c",
                "sha256": "832c534e20fd94dde2014dec735e3bcbf48c2b3859e155a737ef709ccbdc30b8"
            },
            "downloads": -1,
            "filename": "bloggerer-0.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a11f907c52c09c15077a06ff59b7814c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 8983,
            "upload_time": "2023-06-27T06:28:47",
            "upload_time_iso_8601": "2023-06-27T06:28:47.824401Z",
            "url": "https://files.pythonhosted.org/packages/6a/a0/7ff690c60f437d65bd8c7e05a98e85eb9c8778d5032a30af47b4744abe8d/bloggerer-0.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a80334e1dc27e1bc5f9709db6391d8a737cf5c73eb3230ceea7c547434d6027d",
                "md5": "2962967c8c2704c2677abcb6c54784fc",
                "sha256": "672bf4a05459746e4dcd098c4348e4afe0c254ee4f06cc171dce4f07cda469f7"
            },
            "downloads": -1,
            "filename": "bloggerer-0.9.tar.gz",
            "has_sig": false,
            "md5_digest": "2962967c8c2704c2677abcb6c54784fc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 6713,
            "upload_time": "2023-06-27T06:28:49",
            "upload_time_iso_8601": "2023-06-27T06:28:49.543223Z",
            "url": "https://files.pythonhosted.org/packages/a8/03/34e1dc27e1bc5f9709db6391d8a737cf5c73eb3230ceea7c547434d6027d/bloggerer-0.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-27 06:28:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ChaosData",
    "github_project": "bloggerer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "bloggerer"
}