mkdocs-blogging-plugin

Name	mkdocs-blogging-plugin JSON
Version	2.2.11 JSON
	download
home_page
Summary	Mkdocs plugin that generates a blog index page sorted by creation date.
upload_time	2023-07-21 03:55:45
maintainer
docs_url	None
author	Liang Yesheang
requires_python	>=3.6
license	MIT
keywords	mkdocs blog plugin
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mkdocs-blogging-plugin

A mkdocs plugin that generates a blog page listing selected pages, sorted by time. It supports:

- Automatic blog page generation
- Tags
- Category-level customization
- Template-based customization

Demo site: https://liang2kl.github.io/mkdocs-blogging-plugin-example

![preview](https://s2.loli.net/2021/12/03/GqhwCYTsimlkXK1.png)

## Prerequisites

- Only `material` theme is adapted by far
- `navigation.instant` feature cannot be enabled if blog paging is on

Pull requests are welcome to break these constraints.

## Installation

```shell
# macOS or Linux
pip3 install mkdocs-blogging-plugin

# Windows
pip install mkdocs-blogging-plugin
```

## Usage

A complete guide is available at https://liang2kl.github.io/mkdocs-blogging-plugin.

The easiest way to setup everything from scratch is generating your project from [the template repository](https://github.com/liang2kl/mkdocs-blogging-plugin-bootstrap).

## Credits

Inspired by [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) and [mkdocs-material-blog](https://github.com/vuquangtrong/mkdocs-material-blog).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "mkdocs-blogging-plugin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "mkdocs blog plugin",
    "author": "Liang Yesheang",
    "author_email": "liang2kl@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/da/1e/fb81d3ac143643c3ecf52ba7c3d1af24c5000e7ec5f43763bda7b289e378/mkdocs-blogging-plugin-2.2.11.tar.gz",
    "platform": null,
    "description": "# mkdocs-blogging-plugin\n\nA mkdocs plugin that generates a blog page listing selected pages, sorted by time. It supports:\n\n- Automatic blog page generation\n- Tags\n- Category-level customization\n- Template-based customization\n\nDemo site: https://liang2kl.github.io/mkdocs-blogging-plugin-example\n\n![preview](https://s2.loli.net/2021/12/03/GqhwCYTsimlkXK1.png)\n\n## Prerequisites\n\n- Only `material` theme is adapted by far\n- `navigation.instant` feature cannot be enabled if blog paging is on\n\nPull requests are welcome to break these constraints.\n\n## Installation\n\n```shell\n# macOS or Linux\npip3 install mkdocs-blogging-plugin\n\n# Windows\npip install mkdocs-blogging-plugin\n```\n\n## Usage\n\nA complete guide is available at https://liang2kl.github.io/mkdocs-blogging-plugin.\n\nThe easiest way to setup everything from scratch is generating your project from [the template repository](https://github.com/liang2kl/mkdocs-blogging-plugin-bootstrap).\n\n## Credits\n\nInspired by [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) and [mkdocs-material-blog](https://github.com/vuquangtrong/mkdocs-material-blog).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Mkdocs plugin that generates a blog index page sorted by creation date.",
    "version": "2.2.11",
    "project_urls": {
        "Source": "https://github.com/liang2kl/mkdocs-blogging-plugin"
    },
    "split_keywords": [
        "mkdocs",
        "blog",
        "plugin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a046bbcbb8e1eb3e7f223f69c1851f1785292a5fbd51af6443ba9e00715528bf",
                "md5": "48b7876ad21a8f415666f45a5d841d7e",
                "sha256": "7e0f14e5a5d9d7fa106ee014b04a49e2fdb5ffe70a0026106dceb79930ba8ac2"
            },
            "downloads": -1,
            "filename": "mkdocs_blogging_plugin-2.2.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "48b7876ad21a8f415666f45a5d841d7e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 18696,
            "upload_time": "2023-07-21T03:55:44",
            "upload_time_iso_8601": "2023-07-21T03:55:44.302120Z",
            "url": "https://files.pythonhosted.org/packages/a0/46/bbcbb8e1eb3e7f223f69c1851f1785292a5fbd51af6443ba9e00715528bf/mkdocs_blogging_plugin-2.2.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "da1efb81d3ac143643c3ecf52ba7c3d1af24c5000e7ec5f43763bda7b289e378",
                "md5": "ba2f2eb2bdc6c2ee0a1002dfa58408c8",
                "sha256": "91b3ebc1ee3870958a0f9304d985f73a8e170a1f8d17948488415fa1a4257b2e"
            },
            "downloads": -1,
            "filename": "mkdocs-blogging-plugin-2.2.11.tar.gz",
            "has_sig": false,
            "md5_digest": "ba2f2eb2bdc6c2ee0a1002dfa58408c8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 14344,
            "upload_time": "2023-07-21T03:55:45",
            "upload_time_iso_8601": "2023-07-21T03:55:45.739387Z",
            "url": "https://files.pythonhosted.org/packages/da/1e/fb81d3ac143643c3ecf52ba7c3d1af24c5000e7ec5f43763bda7b289e378/mkdocs-blogging-plugin-2.2.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-21 03:55:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "liang2kl",
    "github_project": "mkdocs-blogging-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "mkdocs-blogging-plugin"
}