add documentation

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
     hooks:
       - id: isort
         name: isort
-        entry: isort
+        entry: poetry run isort
         language: system
         types: [python]
         args: ["."]
@@ -21,7 +21,7 @@ repos:
     hooks:
       - id: pylint
         name: pylint
-        entry: pylint
+        entry: poetry run pylint
         language: system
         types: [python]
         args: [

README.md

@@ -1 +1,56 @@
 # mkdocs-jconfig-plugin
+
+This MkDocs plugin allows to process configuration variables using [Jinja](https://jinja.palletsprojects.com/) templates.
+
+## Installation
+
+Install the package with pip:
+
+```bash
+pip install mkdocs-jconfig-plugin
+```
+
+Activate the plugin in `mkdocs.yml`:
+
+```yaml
+plugins:
+  - search
+  - calendar
+  - jconfig
+```
+
+## Configuration
+
+The plugin can be configured in the `plugins` section of `mkdocs.yml` as follows:
+
+```yaml
+plugins:
+  - search
+  - calendar
+  - jconfig:
+      items:
+        - copyright
+```
+
+The plugin supports the following configuration options:
+
+| Option  | Description                                               |
+|---------|-----------------------------------------------------------|
+| `items` | The configuration variables to process. Defaults to `[]`. |
+
+## Typical usage
+
+This plugin is useful when you want to automatically adjust the year in the copyright:
+
+```yaml
+copyright: copyright {{ cal.today.year }} The Authors
+
+plugins:
+  - search
+  - calendar
+  - jconfig:
+      items:
+        - copyright
+```
+
+Note that you need to activate the [calendar](https://github.com/supcik/mkdocs-calendar-plugin) plugin for this to work.

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "mkdocs-jconfig-plugin"
-version = "0.1.0"
-description = "An MkDocs plugin to ..."
+version = "0.1.1"
+description = "An MkDocs plugin to process configuration items with Jinja2"
 authors = ["Jacques Supcik <[email protected]>"]
 repository = "https://github.com/supcik/mkdocs-jconfig-plugin"
 license = "Apache-2"
@@ -29,6 +29,7 @@ black = "^23.3.0"
 pylint = "^2.17.4"
 isort = "^5.12.0"
 pre-commit = "^3.3.3"
+mkdocs-calendar-plugin = "^0.3.0"
 
 [build-system]
 requires = ["poetry-core"]

test/simple/docs/index.md

@@ -1,5 +1 @@
 # Hello
-
-{{ test }}
-
-Year : {{ year }}

test/simple/mkdocs.yml

@@ -1,20 +1,15 @@
 site_name: JConfig Plugin Test
 site_description: Test for JConfig Plugin
-copyright: copyright {{ year }}
+copyright: copyright {{ cal.today.year }} The Authors
 docs_dir: docs
 theme: readthedocs
 
 nav:
   - Main: index.md
 
-extra:
-  year: 2023
-  test: we are in {{ year }}
-
 plugins:
   - search
+  - calendar
   - jconfig:
       items:
         - copyright
-        - extra.test
-  - macros