docs: switch to Material theme and revamp sections

.github/workflows/documentation.yml

@@ -16,7 +16,8 @@ on:
   pull_request:
     branches: [main]
     paths:
-      - ".github/workflows/documentation.yml"
+      - .github/workflows/documentation.yml
+      - docs/
       - requirements/documentation.txt
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages

.pre-commit-config.yaml

@@ -14,6 +14,7 @@ repos:
       - id: check-json
       - id: check-toml
       - id: check-yaml
+        args: [--unsafe]
       - id: detect-private-key
       - id: end-of-file-fixer
       - id: fix-byte-order-marker

CONTRIBUTING.md

@@ -1,67 +1 @@
-# Contributing Guidelines
-
-First off, thanks for considering to contribute to this project!
-
-These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
-
-## Git hooks
-
-We use git hooks through [pre-commit](https://pre-commit.com/) to enforce and automatically check some "rules". Please install it before to push any commit.
-
-See the relevant configuration file: `.pre-commit-config.yaml`.
-
-## Code Style
-
-Make sure your code *roughly* follows [PEP-8](https://www.python.org/dev/peps/pep-0008/) and keeps things consistent with the rest of the code:
-
-- docstrings: [sphinx-style](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html#the-sphinx-docstring-format) is used to write technical documentation.
-- formatting: [black](https://black.readthedocs.io/) is used to automatically format the code without debate.
-- sorted imports: [isort](https://pycqa.github.io/isort/) is used to sort imports
-- static analysis: [flake8](https://flake8.pycqa.org/en/latest/) is used to catch some dizziness and keep the source code healthy.
-
-## Pulls requests
-
-Pull requests are really welcome since you take the time to push or modify tests related to the code you edit or create.
-
-----
-
-## IDE
-
-Feel free to use the IDE you love. Here come configurations for some popular IDEs to fit those guidelines.
-
-### Visual Studio Code
-
-```jsonc
-{
-    // Editor
-    "files.associations": {
-        "./requirements/*.txt": "pip-requirements"
-    },
-    // Python
-    "[python]": {
-        "editor.codeActionsOnSave": {
-            "source.organizeImports": true
-        },
-        "editor.defaultFormatter": "ms-python.black-formatter",
-        "editor.formatOnSave": true,
-        "editor.guides.bracketPairs": "active",
-        "editor.rulers": [
-            88
-        ],
-        "editor.wordWrapColumn": 88,
-    },
-    "flake8.args": [
-        "--config=setup.cfg",
-        "--verbose"
-    ],
-    "isort.args": [
-        "--profile",
-        "black"
-    ],
-    "isort.check": true,
-    // extensions
-    "autoDocstring.guessTypes": true,
-    "autoDocstring.docstringFormat": "google",
-    "autoDocstring.generateDocstringOnEnter": false,
-}
-```
+Contributing guidelines are now published on [the online documentation](https://guts.github.io/mkdocs-rss-plugin/changelog/).

README.md

@@ -14,6 +14,12 @@
 
 A plugin for [MkDocs](https://www.mkdocs.org), the static site generator, which creates [RSS 2.0](https://wikipedia.org/wiki/RSS) feeds using the creation and modification dates from [git log](https://git-scm.com/docs/git-log) and page metadata ([YAML frontmatter](https://www.mkdocs.org/user-guide/writing-your-docs/#yaml-style-meta-data)).
 
+## Installation
+
+```sh
+pip install mkdocs-rss-plugin
+```
+
 ## Usage
 
 Minimal [`mkdocs.yml` configuration](https://www.mkdocs.org/user-guide/configuration/#project-information):