.gitlab-ci.yml

@@ -5,7 +5,7 @@ include:
   - { project: gitlab/ci-templates, file: build/python.yml }
   - { project: gitlab/ci-templates, file: release/semantic.yml }
   - { project: gitlab/ci-templates, file: release/python.yml }
-  # - { project: gitlab/ci-templates, file: release/github.yml }
+  - { project: gitlab/ci-templates, file: release/github.yml }
 
 workflow:
   rules:
@@ -14,10 +14,6 @@ workflow:
       when: never
     - if: $CI_PIPELINE_SOURCE =~ /api|push|merge|web/
 
-variables:
-  TWINE_SKIP: pypi
-  GITHUB_UPSTREAM: derJD/python-mkblog
-
 stages:
   - lint
   - build

CHANGELOG.md

 # Changelog
 
+### [1.0.1](https://gitlab.der-jd.de/python/mkblog/compare/1.0.0...1.0.1) (2021-03-19)
+
+
+### Bug Fixes
+
+* Add readme ([7388a2c](https://gitlab.der-jd.de/python/mkblog/commit/7388a2c41700d87017aa9f6d9bb5d6395294a309))
+
+
+### Documentation
+
+* Add badge ([7864eb0](https://gitlab.der-jd.de/python/mkblog/commit/7864eb0cbd04a4ee89ea29f7529d792504277033))
+
+
+### Continuous Integration
+
+* Add publish to github job ([04e952c](https://gitlab.der-jd.de/python/mkblog/commit/04e952cafea72afae10e9f00d298e95508da0ba2))
+
+
+### Build System
+
+* **makefile:** Add build package to comment ([fff93ea](https://gitlab.der-jd.de/python/mkblog/commit/fff93eac5b634e06dd478f26daa34715ab331e18))
+* **Makefile:** Clean up podman command ([f70fce2](https://gitlab.der-jd.de/python/mkblog/commit/f70fce28b0176ada33ffa3f3f630bd405ee48497))
+* **setup:** Fix license classifier ([d6609c9](https://gitlab.der-jd.de/python/mkblog/commit/d6609c9928e352d8277a903576528d50b03e8aa6))
+
 ## 1.0.0 (2021-03-16)
 
 

Makefile

-PODMAN := podman run -it --rm -v ./:/builds/${PWD##*/} -w /builds/${PWD##*/} gitlab.der-jd.de:5050/containers/python-build:latest
+# containers/python-build is located on a private registry
+#  which is known to podman via ~/.config/containers/registries.conf
+# containers/python-build is a container with
+#   build, setuptools_scm, pylint, twine installed via pip3
+#
+PODMAN := podman run -it --rm \
+			--pull always \
+			-v ./:/builds/${PWD##*/} \
+			-w /builds/${PWD##*/} \
+			containers/python-build:latest
 
 .PHONY: all help
 
 all: help
 
 package:
-	${PODMAN} pylint pyproject-build --sdist --wheel
+	${PODMAN} pyproject-build --sdist --wheel
+
 install:
 	pip install .
+
 list:
 	pip show ${PWD##*/}
+
 lint:
 	${PODMAN} bash -c 'pip install .; pylint --exit-zero -f parseable src/'
-container:
-	@echo "#########################################################"
-	@echo "# pip install .                                         #"
-	@echo "# mkdocs -v serve -f example/mkdocs.yml -a 0.0.0.0:8000 #"
-	@echo "#########################################################"
-
-	podman run -it --rm \
-		--pull always \
-		-p 8000:8000 \
-		-v ./:/builds/$${PWD##*/} \
-		-w /builds/$${PWD##*/} \
-		gitlab.der-jd.de:5050/containers/mkdocs:latest bash
+
+serve:
+	${PODMAN} bash -c 'pip install .; mkdocs -v serve -f example/mkdocs.yml -a 0.0.0.0:8000'
 
 help:
 	@echo -e "Available targets:\n"

README.md

 # python-mkblog
 
 [![PyPI version](https://badge.fury.io/py/python-mkblog.svg)](https://badge.fury.io/py/python-mkblog)
+[![PyPI downloads](https://img.shields.io/pypi/dm/mkblog)](https://pypi.org/project/mkblog/)
 [![pylint](https://gitlab.der-jd.de/python/mkblog/-/jobs/artifacts/main/raw/pylint.svg?job=lint:pylint)](#python-mkblog)
 
+This is yet another MkDocs plugin adding basic blogging functionality.
+With this plugin you store your blogposts in a separate `blog` directory.
+
+![example tree](/img/mkblog_example_tree.jpg)
+
+As you can see it doesn't matter how you store your posts in the `blog` directory.
+Instead of directory structures, this plugin relies on markdown Metadata `date`.
+
+![example page](/img/mkblog_example_page.jpg)
+
+Use this plugin alongside with the plugin [awesome-pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin).
+`awesome-pages` will take care of generating the whole nav bar, so you (or this blog plugin) don't have to do it.
+
+## Features
+
+* Extra directory for your blog posts
+* Utilizing markdown meta `date`
+* No need for date directories and subdirectories and sub sub directories
+
 ## Installation
 
 * from pypi: `pip install python-mkblog`
@@ -18,16 +38,62 @@ pip install .
 
 ## Usage
 
-### Quick Start
+There is an complete [example](/example/) directory.
+Take a look by cloning this repository and issuing `mkdocs serve -f example/mkdocs.yml`
+
+**Most basic example `mkdocs.yml`**:
+
+```yaml
+---
+
+site_name: basic test page
+
+plugins:
+  - awesome-pages
+  - mkblog
+
+```
+
+**This example uses `material theme` to make the site prettier and it uses `discus extra` to give people the opportunity to leave a comment**:
+
+```yaml
+---
+
+site_name: test page with comments
+
+theme:
+  name: material
+  features:
+    - tabs
+  palette:
+    primary: green
+    accent: yellow
+
+plugins:
+  - mkblog
+  - search
+  - awesome-pages
 
-### Config
+extra:
+  disqus: <YOUR DISQUS TOKEN>
 
-### CLI
+```
+
+**You can configure the name of your blog directory**:
+
+```yaml
+---
+
+plugins:
+  - mkblog:
+      blog_dir: bloggiemcblogger
+
+```
 
 ## Documentation
 
-* [General documentation](https://der-jd.de/mkblog/intro/)
-* [Reference](https://der-jd.de/mkblog/reference/mailcow/)
+* [General documentation](https://der-jd.de/python-mkblog/intro/)
+* [Reference](https://der-jd.de/python-mkblog/reference/mkblog/)
 
 ## License
 

setup.cfg

@@ -16,7 +16,7 @@ classifiers =
   Programming Language :: Python :: 3.7
   Programming Language :: Python :: 3.8
   Programming Language :: Python :: 3.9
-  License :: OSI Approved :: MIT
+  License :: OSI Approved :: MIT License
   Topic :: System :: Systems Administration
   Topic :: Utilities