mkdocs-simple-blog


Namemkdocs-simple-blog JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/FernandoCelmer/mkdocs-simple-blog
SummaryMkdocs Blog Theme
upload_time2025-02-04 01:57:05
maintainerNone
docs_urlNone
authorFernando Celmer
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements mkdocs mkdocs-simple-blog
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # [MkDocs Simple Blog](https://fernandocelmer.github.io/mkdocs-simple-blog/)
>  Theme for [MkDocs](https://www.mkdocs.org/)

![Image](https://raw.githubusercontent.com/FernandoCelmer/mkdocs-simple-blog/develop/docs/assets/simple-blog.png)

![GitHub forks](https://img.shields.io/github/forks/FernandoCelmer/mkdocs-simple-blog?label=Forks&style=flat-square)
![GitHub Repo stars](https://img.shields.io/github/stars/FernandoCelmer/mkdocs-simple-blog?label=Stars&style=flat-square)
![GitHub last commit](https://img.shields.io/github/last-commit/FernandoCelmer/mkdocs-simple-blog?style=flat-square)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/FernandoCelmer/mkdocs-simple-blog/python-publish-pypi.yml?label=%F0%9F%93%A6%20PyPI&style=flat-square)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/FernandoCelmer/mkdocs-simple-blog/python-publish-pypi-test.yml?label=%F0%9F%93%A6%20PyPI-Test&style=flat-square)

## Install

### Installation MkDocs

To install MkDocs, run the following command from the command line:

```bash
pip install mkdocs
```

### Installation theme

Install the theme using PIP:

```bash
pip install mkdocs-simple-blog
```

### Activating theme

After the theme is installed, edit your `mkdocs.yml` file and set the theme name to `simple-blog`:

```yml
theme:
    name: simple-blog
```

## Getting Help

We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.

- 🐛 [Bug Report](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)
- 📕 [Documentation Issue](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)
- 🚀 [Feature Request](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)
- 💬 [General Question](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)

## Commit Style

- ⚙️ FEATURE
- 📝 PEP8
- 📌 ISSUE
- 🪲 BUG
- 📘 DOCS
- 📦 PyPI
- ❤️️ TEST
- ⬆️ CI/CD
- ⚠️ SECURITY

## License
![GitHub License](https://img.shields.io/github/license/FernandoCelmer/mkdocs-simple-blog)

This project is licensed under the terms of the GNU General Public License v3.0.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/FernandoCelmer/mkdocs-simple-blog",
    "name": "mkdocs-simple-blog",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Fernando Celmer",
    "author_email": "email@fernandocelmer.com",
    "download_url": "https://files.pythonhosted.org/packages/4d/37/05f1905f23bb9eeb96046381193176d98bfc46b8f82904aa2900ab6ebe04/mkdocs_simple_blog-0.1.0.tar.gz",
    "platform": null,
    "description": "# [MkDocs Simple Blog](https://fernandocelmer.github.io/mkdocs-simple-blog/)\n>  Theme for [MkDocs](https://www.mkdocs.org/)\n\n![Image](https://raw.githubusercontent.com/FernandoCelmer/mkdocs-simple-blog/develop/docs/assets/simple-blog.png)\n\n![GitHub forks](https://img.shields.io/github/forks/FernandoCelmer/mkdocs-simple-blog?label=Forks&style=flat-square)\n![GitHub Repo stars](https://img.shields.io/github/stars/FernandoCelmer/mkdocs-simple-blog?label=Stars&style=flat-square)\n![GitHub last commit](https://img.shields.io/github/last-commit/FernandoCelmer/mkdocs-simple-blog?style=flat-square)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/FernandoCelmer/mkdocs-simple-blog/python-publish-pypi.yml?label=%F0%9F%93%A6%20PyPI&style=flat-square)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/FernandoCelmer/mkdocs-simple-blog/python-publish-pypi-test.yml?label=%F0%9F%93%A6%20PyPI-Test&style=flat-square)\n\n## Install\n\n### Installation MkDocs\n\nTo install MkDocs, run the following command from the command line:\n\n```bash\npip install mkdocs\n```\n\n### Installation theme\n\nInstall the theme using PIP:\n\n```bash\npip install mkdocs-simple-blog\n```\n\n### Activating theme\n\nAfter the theme is installed, edit your `mkdocs.yml` file and set the theme name to `simple-blog`:\n\n```yml\ntheme:\n    name: simple-blog\n```\n\n## Getting Help\n\nWe use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.\n\n- \ud83d\udc1b [Bug Report](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)\n- \ud83d\udcd5 [Documentation Issue](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)\n- \ud83d\ude80 [Feature Request](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)\n- \ud83d\udcac [General Question](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)\n\n## Commit Style\n\n- \u2699\ufe0f FEATURE\n- \ud83d\udcdd PEP8\n- \ud83d\udccc ISSUE\n- \ud83e\udeb2 BUG\n- \ud83d\udcd8 DOCS\n- \ud83d\udce6 PyPI\n- \u2764\ufe0f\ufe0f TEST\n- \u2b06\ufe0f CI/CD\n- \u26a0\ufe0f SECURITY\n\n## License\n![GitHub License](https://img.shields.io/github/license/FernandoCelmer/mkdocs-simple-blog)\n\nThis project is licensed under the terms of the GNU General Public License v3.0.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Mkdocs Blog Theme",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/FernandoCelmer/mkdocs-simple-blog"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "aa9b6578ff46dce4740a0e9dff75d94bce56b5c1ff212bf1eca3c7507e23c2d2",
                "md5": "1ee855a67f7e3135346ea9aafd457e21",
                "sha256": "bfeddd6f2a0b5f2a6efbfd8cf423588b684ffae4393ac427ef9eb313e3964ae5"
            },
            "downloads": -1,
            "filename": "mkdocs_simple_blog-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1ee855a67f7e3135346ea9aafd457e21",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 292052,
            "upload_time": "2025-02-04T01:57:03",
            "upload_time_iso_8601": "2025-02-04T01:57:03.961083Z",
            "url": "https://files.pythonhosted.org/packages/aa/9b/6578ff46dce4740a0e9dff75d94bce56b5c1ff212bf1eca3c7507e23c2d2/mkdocs_simple_blog-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4d3705f1905f23bb9eeb96046381193176d98bfc46b8f82904aa2900ab6ebe04",
                "md5": "45091082001d88a71fec5bd899a37bde",
                "sha256": "17d41e97dbe57d5b1feadda25be6576fcff747cb4eadd479ab93c591ace6e79f"
            },
            "downloads": -1,
            "filename": "mkdocs_simple_blog-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "45091082001d88a71fec5bd899a37bde",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 286230,
            "upload_time": "2025-02-04T01:57:05",
            "upload_time_iso_8601": "2025-02-04T01:57:05.997578Z",
            "url": "https://files.pythonhosted.org/packages/4d/37/05f1905f23bb9eeb96046381193176d98bfc46b8f82904aa2900ab6ebe04/mkdocs_simple_blog-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-04 01:57:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "FernandoCelmer",
    "github_project": "mkdocs-simple-blog",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "mkdocs",
            "specs": [
                [
                    "==",
                    "1.6.1"
                ]
            ]
        },
        {
            "name": "mkdocs-simple-blog",
            "specs": [
                [
                    "==",
                    "0.0.9"
                ]
            ]
        }
    ],
    "lcname": "mkdocs-simple-blog"
}
        
Elapsed time: 1.39788s